{"openapi":"3.0.3","info":{"title":"Infisical API","description":"List of all available APIs that can be consumed","version":"0.0.1"},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"An access token in Infisical"}},"schemas":{}},"paths":{"/api/status":{"get":{"operationId":"getInstanceStatus","tags":["Instance"],"description":"Get the status of the Infisical instance and the features configured on it. Public and unauthenticated; used by liveness and readiness probes and exempt from the API-wide rate limit.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"message":{"type":"string"},"emailConfigured":{"type":"boolean"},"inviteOnlySignup":{"type":"boolean"},"redisConfigured":{"type":"boolean"},"secretScanningConfigured":{"type":"boolean"},"samlDefaultOrgSlug":{"type":"string"},"auditLogStorageDisabled":{"type":"boolean"},"maxIdentityAccessTokenTTL":{"type":"number"}},"required":["date"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/organization/roles":{"post":{"tags":["Organization Roles"],"description":"Create an organization role","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":64,"description":"The slug of the role."},"name":{"type":"string","minLength":1,"description":"The name of the role."},"description":{"type":"string","nullable":true,"description":"The description for the role."},"permissions":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"subject":{"type":"string","enum":["workspace"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create"]},{"type":"array","items":{"type":"string","enum":["create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["project"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create","request-access"]},{"type":"array","items":{"type":"string","enum":["create","request-access"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["role"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["sub-organization"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create","edit","delete","direct-access","link-group"]},{"type":"array","items":{"type":"string","enum":["create","edit","delete","direct-access","link-group"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["member"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["settings"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["incident-contact"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["sso"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","bypass-sso-enforcement"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","bypass-sso-enforcement"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["scim"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["github-org-sync"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["github-org-sync-manual"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ldap"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["groups"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","add-identities","add-members","remove-members","remove-identities"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","add-identities","add-members","remove-members","remove-identities"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["billing"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","manage-billing"]},{"type":"array","items":{"type":"string","enum":["read","manage-billing"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["identity"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","revoke-auth","edit-auth","create-token","get-token","delete-token"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","revoke-auth","edit-auth","create-token","get-token","delete-token"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kms"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["audit-logs"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","edit"]},{"type":"array","items":{"type":"string","enum":["read","edit"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["project-templates"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["app-connections"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","connect","rotate-credentials"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","connect","rotate-credentials"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["organization-admin-console"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["access-all-projects"]},{"type":"array","items":{"type":"string","enum":["access-all-projects"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-share"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["manage-settings"]},{"type":"array","items":{"type":"string","enum":["manage-settings"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kmip"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["proxy"]},{"type":"array","items":{"type":"string","enum":["proxy"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["machine-identity-auth-template"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["list-templates","edit-templates","create-templates","delete-templates","unlink-templates","attach-templates"]},{"type":"array","items":{"type":"string","enum":["list-templates","edit-templates","create-templates","delete-templates","unlink-templates","attach-templates"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["gateway"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create-gateways","list-gateways","edit-gateways","delete-gateways","attach-gateways","revoke-gateway-access"]},{"type":"array","items":{"type":"string","enum":["create-gateways","list-gateways","edit-gateways","delete-gateways","attach-gateways","revoke-gateway-access"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["gateway-pool"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create-gateway-pools","list-gateway-pools","edit-gateway-pools","delete-gateway-pools","attach-gateway-pools"]},{"type":"array","items":{"type":"string","enum":["create-gateway-pools","list-gateway-pools","edit-gateway-pools","delete-gateway-pools","attach-gateway-pools"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["relay"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create-relays","list-relays","edit-relays","delete-relays","revoke-relay-access"]},{"type":"array","items":{"type":"string","enum":["create-relays","list-relays","edit-relays","delete-relays","revoke-relay-access"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kmip-server"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create-kmip-servers","list-kmip-servers","edit-kmip-servers","delete-kmip-servers","revoke-kmip-server-access"]},{"type":"array","items":{"type":"string","enum":["create-kmip-servers","list-kmip-servers","edit-kmip-servers","delete-kmip-servers","revoke-kmip-server-access"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["email-domains"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","verify-domain","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","verify-domain","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-manager"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","manage-instance","manage-settings"]},{"type":"array","items":{"type":"string","enum":["read","manage-instance","manage-settings"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["honey-tokens"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["setup"]},{"type":"array","items":{"type":"string","enum":["setup"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["oauth-clients"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secrets-management-insights"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","generate-report","delete-report","search-all-secret-values"]},{"type":"array","items":{"type":"string","enum":["read","generate-report","delete-report","search-all-secret-values"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false}]},"description":"The permissions assigned to the role."}},"required":["slug","name","permissions"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"slug":{"type":"string"},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug","permissions","createdAt","updatedAt","orgId"],"additionalProperties":false}},"required":["role"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"tags":["Organization Roles"],"description":"List organization roles","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"slug":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug","createdAt","updatedAt","orgId"],"additionalProperties":false}}},"required":["roles"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/organization/roles/{roleId}":{"get":{"tags":["Organization Roles"],"description":"Get an organization role","parameters":[{"schema":{"type":"string"},"in":"path","name":"roleId","required":true,"description":"The ID of the role to get."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"slug":{"type":"string"},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug","permissions","createdAt","updatedAt","orgId"],"additionalProperties":false}},"required":["role"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["Organization Roles"],"description":"Update an organization role","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":64,"description":"The slug of the role."},"name":{"type":"string","description":"The name of the role."},"description":{"type":"string","nullable":true,"description":"The description for the role."},"permissions":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"subject":{"type":"string","enum":["workspace"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create"]},{"type":"array","items":{"type":"string","enum":["create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["project"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create","request-access"]},{"type":"array","items":{"type":"string","enum":["create","request-access"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["role"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["sub-organization"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create","edit","delete","direct-access","link-group"]},{"type":"array","items":{"type":"string","enum":["create","edit","delete","direct-access","link-group"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["member"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["settings"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["incident-contact"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["sso"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","bypass-sso-enforcement"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","bypass-sso-enforcement"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["scim"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["github-org-sync"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["github-org-sync-manual"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ldap"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["groups"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","add-identities","add-members","remove-members","remove-identities"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","add-identities","add-members","remove-members","remove-identities"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["billing"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","manage-billing"]},{"type":"array","items":{"type":"string","enum":["read","manage-billing"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["identity"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","revoke-auth","edit-auth","create-token","get-token","delete-token"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","revoke-auth","edit-auth","create-token","get-token","delete-token"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kms"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["audit-logs"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","edit"]},{"type":"array","items":{"type":"string","enum":["read","edit"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["project-templates"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["app-connections"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","connect","rotate-credentials"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","connect","rotate-credentials"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["organization-admin-console"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["access-all-projects"]},{"type":"array","items":{"type":"string","enum":["access-all-projects"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-share"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["manage-settings"]},{"type":"array","items":{"type":"string","enum":["manage-settings"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kmip"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["proxy"]},{"type":"array","items":{"type":"string","enum":["proxy"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["machine-identity-auth-template"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["list-templates","edit-templates","create-templates","delete-templates","unlink-templates","attach-templates"]},{"type":"array","items":{"type":"string","enum":["list-templates","edit-templates","create-templates","delete-templates","unlink-templates","attach-templates"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["gateway"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create-gateways","list-gateways","edit-gateways","delete-gateways","attach-gateways","revoke-gateway-access"]},{"type":"array","items":{"type":"string","enum":["create-gateways","list-gateways","edit-gateways","delete-gateways","attach-gateways","revoke-gateway-access"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["gateway-pool"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create-gateway-pools","list-gateway-pools","edit-gateway-pools","delete-gateway-pools","attach-gateway-pools"]},{"type":"array","items":{"type":"string","enum":["create-gateway-pools","list-gateway-pools","edit-gateway-pools","delete-gateway-pools","attach-gateway-pools"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["relay"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create-relays","list-relays","edit-relays","delete-relays","revoke-relay-access"]},{"type":"array","items":{"type":"string","enum":["create-relays","list-relays","edit-relays","delete-relays","revoke-relay-access"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kmip-server"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create-kmip-servers","list-kmip-servers","edit-kmip-servers","delete-kmip-servers","revoke-kmip-server-access"]},{"type":"array","items":{"type":"string","enum":["create-kmip-servers","list-kmip-servers","edit-kmip-servers","delete-kmip-servers","revoke-kmip-server-access"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["email-domains"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","verify-domain","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","verify-domain","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-manager"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","manage-instance","manage-settings"]},{"type":"array","items":{"type":"string","enum":["read","manage-instance","manage-settings"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["honey-tokens"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["setup"]},{"type":"array","items":{"type":"string","enum":["setup"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["oauth-clients"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secrets-management-insights"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","generate-report","delete-report","search-all-secret-values"]},{"type":"array","items":{"type":"string","enum":["read","generate-report","delete-report","search-all-secret-values"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false}]},"description":"The permissions assigned to the role."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"roleId","required":true,"description":"The ID of the role to update."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"slug":{"type":"string"},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug","permissions","createdAt","updatedAt","orgId"],"additionalProperties":false}},"required":["role"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["Organization Roles"],"description":"Delete an organization role","parameters":[{"schema":{"type":"string"},"in":"path","name":"roleId","required":true,"description":"The ID of the role to delete."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"slug":{"type":"string"},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug","permissions","createdAt","updatedAt","orgId"],"additionalProperties":false}},"required":["role"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/organization/roles/slug/{roleSlug}":{"get":{"tags":["Organization Roles"],"description":"Get an organization role by slug","parameters":[{"schema":{"type":"string"},"in":"path","name":"roleSlug","required":true,"description":"The slug of the role to get details."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"slug":{"type":"string"},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug","permissions","createdAt","updatedAt","orgId"],"additionalProperties":false}},"required":["role"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/sub-organizations":{"post":{"operationId":"createSubOrganization","tags":["Sub Organizations"],"description":"Create a sub organization","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The display name of the sub-organization (e.g. 'Acme Corp'). Allows alphanumeric characters, spaces, dashes, and underscores."},"slug":{"type":"string","minLength":1,"maxLength":64,"description":"Optional. The slug of the sub-organization (e.g. 'acme-corp'). If not provided, it is auto-generated from the name. Must be lowercase with hyphens only."}},"required":["name"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"organization":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"parentOrgId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","createdAt","updatedAt"],"additionalProperties":false}},"required":["organization"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listSubOrganizations","tags":["Sub Organizations"],"description":"List of sub organizations","parameters":[{"schema":{"type":"number","minimum":1,"maximum":1000,"default":25},"in":"query","name":"limit","required":false,"description":"The number of sub organizations to return."},{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th sub organization."},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"Optional. Filter sub organizations by name (case-insensitive substring match)."},{"schema":{"type":"string","enum":["name"],"default":"name"},"in":"query","name":"orderBy","required":false,"description":"The field to order sub organizations by. Currently only 'name' is supported."},{"schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"in":"query","name":"orderDirection","required":false,"description":"The direction to order sub organizations. Either 'asc' or 'desc'."},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"isAccessible","required":false,"description":"Filter to only return sub organizations that the actor has access to."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"parentOrgId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","createdAt","updatedAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["organizations","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/sub-organizations/{subOrgId}":{"patch":{"operationId":"updateSubOrganization","tags":["Sub Organizations"],"description":"Update a sub organization","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"Optional. The display name of the sub-organization. When only the name is provided (no slug), both name and slug are updated."},"slug":{"type":"string","minLength":1,"maxLength":64,"description":"Optional. The slug of the sub-organization. Can be updated independently when both name and slug are provided."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"subOrgId","required":true,"description":"The id of the sub organization to update."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"organization":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"parentOrgId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","createdAt","updatedAt"],"additionalProperties":false}},"required":["organization"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteSubOrganization","tags":["Sub Organizations"],"description":"Delete a sub organization","parameters":[{"schema":{"type":"string"},"in":"path","name":"subOrgId","required":true,"description":"The id of the sub organization to delete."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"organization":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"parentOrgId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","createdAt","updatedAt"],"additionalProperties":false}},"required":["organization"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/sub-organizations/{subOrgId}/memberships":{"post":{"operationId":"createSubOrganizationMembership","tags":["Sub Organizations"],"description":"Join a sub organization","parameters":[{"schema":{"type":"string"},"in":"path","name":"subOrgId","required":true,"description":"The id of the sub organization to create a membership in."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"organization":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"parentOrgId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","createdAt","updatedAt"],"additionalProperties":false}},"required":["organization"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/roles":{"post":{"tags":["Project Roles"],"description":"Create a project role","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":64,"description":"The slug of the role."},"name":{"type":"string","minLength":1,"description":"The name of the role."},"description":{"type":"string","nullable":true,"description":"The description for the role."},"permissions":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"subject":{"type":"string","enum":["secrets"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","describeSecret","readValue","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","describeSecret","readValue","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretTags":{"type":"object","properties":{"$in":{"type":"array","items":{"type":"string","minLength":1}},"$all":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"eventType":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-folders"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-imports"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["dynamic-secrets"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read-root-credential","create-root-credential","edit-root-credential","delete-root-credential","lease"]},{"type":"array","items":{"type":"string","enum":["read-root-credential","create-root-credential","edit-root-credential","delete-root-credential","lease"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"metadata":{"type":"object","properties":{"$elemMatch":{"type":"object","properties":{"key":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"value":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}},"additionalProperties":false}},"required":["$elemMatch"],"additionalProperties":false}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["identity"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges","revoke-auth","edit-auth","create-token","get-token","delete-token"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges","revoke-auth","edit-auth","create-token","get-token","delete-token"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"identityId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"assignableRole":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"assignableSubject":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableAction":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-subscribers"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},"minItems":1}],"description":"Describe what action an entity can take."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$glob":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-templates"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},"minItems":1}],"description":"Describe what action an entity can take."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$glob":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-rotation"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","read-generated-credentials","create","edit","delete","rotate-secrets"]},{"type":"array","items":{"type":"string","enum":["read","read-generated-credentials","create","edit","delete","rotate-secrets"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-syncs"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","sync-secrets","import-secrets","remove-secrets"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","sync-secrets","import-secrets","remove-secrets"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-syncs"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","sync-certificates","import-certificates","remove-certificates","set-post-sync-command","set-health-check-command","set-target-host"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","sync-certificates","import-certificates","remove-certificates","set-post-sync-command","set-health-check-command","set-target-host"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"subscriberName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-event-subscriptions"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["subscribe-to-creation-events","subscribe-to-update-events","subscribe-to-deletion-events","subscribe-to-import-mutation-events"]},{"type":"array","items":{"type":"string","enum":["subscribe-to-creation-events","subscribe-to-update-events","subscribe-to-deletion-events","subscribe-to-import-mutation-events"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-profiles"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-cert","reveal-acme-eab-secret","rotate-acme-eab-secret","manage-application-attachments"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-cert","reveal-acme-eab-secret","rotate-acme-eab-secret","manage-application-attachments"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"slug":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-policies"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$glob":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-application"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","list","create"]},{"type":"array","items":{"type":"string","enum":["read","list","create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-authorities"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-ca-certificate","sign-intermediate"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-ca-certificate","sign-intermediate"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificates"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","read-private-key","import"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","read-private-key","import"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"commonName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"altNames":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"serialNumber":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"friendlyName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"status":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"metadata":{"type":"object","properties":{"$elemMatch":{"type":"object","properties":{"key":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"value":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}},"additionalProperties":false}},"required":["$elemMatch"],"additionalProperties":false}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-certificate-authorities"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-certificates"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-certificate-templates"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-hosts"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-host-groups"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["mcp-endpoints"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["mcp-servers"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["mcp-activity-logs"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-approval"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-rollback"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create"]},{"type":"array","items":{"type":"string","enum":["read","create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["member"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"userEmail":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableRole":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"assignableSubject":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableAction":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["groups"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"groupName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableRole":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["role"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["integrations"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["webhooks"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["service-tokens"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["settings"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-validation-rules"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["environments"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["tags"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["audit-logs"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","edit"]},{"type":"array","items":{"type":"string","enum":["read","edit"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["insights"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","generate-report","delete-report"]},{"type":"array","items":{"type":"string","enum":["read","generate-report","delete-report"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ip-allowlist"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-alerts"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-collections"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-inventory-views"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-discovery"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","run-scan"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","run-scan"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-certificate-installations"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["code-signers"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","sign"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","sign"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["workspace"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["edit","delete"]},{"type":"array","items":{"type":"string","enum":["edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kms"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["edit"]},{"type":"array","items":{"type":"string","enum":["edit"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["cmek"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","encrypt","decrypt","sign","verify","generate-mac","verify-mac","rotate","export-private-key"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","encrypt","decrypt","sign","verify","generate-mac","verify-mac","rotate","export-private-key"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kmip"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create-clients","update-clients","delete-clients","read-clients","generate-client-certificates"]},{"type":"array","items":{"type":"string","enum":["create-clients","update-clients","delete-clients","read-clients","generate-client-certificates"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["commits"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","perform-rollback"]},{"type":"array","items":{"type":"string","enum":["read","perform-rollback"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning-data-sources"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-data-sources","create-data-sources","edit-data-sources","delete-data-sources","trigger-data-source-scans","read-data-source-scans","read-data-source-resources"]},{"type":"array","items":{"type":"string","enum":["read-data-sources","create-data-sources","edit-data-sources","delete-data-sources","trigger-data-source-scans","read-data-source-scans","read-data-source-resources"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning-findings"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-findings","update-findings"]},{"type":"array","items":{"type":"string","enum":["read-findings","update-findings"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning-configs"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-configs","update-configs"]},{"type":"array","items":{"type":"string","enum":["read-configs","update-configs"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["app-connections"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read-app-connections","create-app-connections","edit-app-connections","delete-app-connections","connect-app-connections","rotate-credentials"]},{"type":"array","items":{"type":"string","enum":["read-app-connections","create-app-connections","edit-app-connections","delete-app-connections","connect-app-connections","rotate-credentials"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["hsm-connectors"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-hsm-connectors","create-hsm-connectors","edit-hsm-connectors","delete-hsm-connectors","test-hsm-connectors","attach-hsm-connectors"]},{"type":"array","items":{"type":"string","enum":["read-hsm-connectors","create-hsm-connectors","edit-hsm-connectors","delete-hsm-connectors","test-hsm-connectors","attach-hsm-connectors"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["honey-tokens"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","read-credentials","create","edit","reset","revoke"]},{"type":"array","items":{"type":"string","enum":["read","read-credentials","create","edit","reset","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["proxied-services"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","proxy","report-usage"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","proxy","report-usage"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["agent-vault-access-bundles"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","manage-members"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","manage-members"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["agent-vault-sessions"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","revoke"]},{"type":"array","items":{"type":"string","enum":["read","create","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["agent-vault-proxies"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-token","revoke"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-token","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["approval-requests"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create"]},{"type":"array","items":{"type":"string","enum":["read","create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["approval-request-grants"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","revoke"]},{"type":"array","items":{"type":"string","enum":["read","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-approval-request"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read"]},{"type":"array","items":{"type":"string","enum":["read"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["project-folder-grant"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read-grant","create-grant","revoke-grant"]},{"type":"array","items":{"type":"string","enum":["read-grant","create-grant","revoke-grant"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false}]},"description":"The permissions assigned to the role."}},"required":["slug","name","permissions"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"Id of the project to create the role for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"slug":{"type":"string"},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"}},"required":["id","name","slug","permissions","createdAt","updatedAt","projectId"],"additionalProperties":false}},"required":["role"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"tags":["Project Roles"],"description":"List project role","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"slug":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"}},"required":["id","name","slug","createdAt","updatedAt","projectId"],"additionalProperties":false}}},"required":["roles"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/roles/{roleId}":{"patch":{"tags":["Project Roles"],"description":"Update a project role","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":64,"description":"The slug of the role."},"name":{"type":"string","description":"The name of the role."},"description":{"type":"string","nullable":true,"description":"The description for the role."},"permissions":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"subject":{"type":"string","enum":["secrets"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","describeSecret","readValue","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","describeSecret","readValue","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretTags":{"type":"object","properties":{"$in":{"type":"array","items":{"type":"string","minLength":1}},"$all":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"eventType":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-folders"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-imports"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["dynamic-secrets"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read-root-credential","create-root-credential","edit-root-credential","delete-root-credential","lease"]},{"type":"array","items":{"type":"string","enum":["read-root-credential","create-root-credential","edit-root-credential","delete-root-credential","lease"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"metadata":{"type":"object","properties":{"$elemMatch":{"type":"object","properties":{"key":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"value":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}},"additionalProperties":false}},"required":["$elemMatch"],"additionalProperties":false}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["identity"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges","revoke-auth","edit-auth","create-token","get-token","delete-token"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges","revoke-auth","edit-auth","create-token","get-token","delete-token"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"identityId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"assignableRole":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"assignableSubject":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableAction":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-subscribers"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},"minItems":1}],"description":"Describe what action an entity can take."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$glob":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-templates"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},"minItems":1}],"description":"Describe what action an entity can take."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$glob":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-rotation"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","read-generated-credentials","create","edit","delete","rotate-secrets"]},{"type":"array","items":{"type":"string","enum":["read","read-generated-credentials","create","edit","delete","rotate-secrets"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-syncs"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","sync-secrets","import-secrets","remove-secrets"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","sync-secrets","import-secrets","remove-secrets"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-syncs"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","sync-certificates","import-certificates","remove-certificates","set-post-sync-command","set-health-check-command","set-target-host"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","sync-certificates","import-certificates","remove-certificates","set-post-sync-command","set-health-check-command","set-target-host"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"subscriberName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-event-subscriptions"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["subscribe-to-creation-events","subscribe-to-update-events","subscribe-to-deletion-events","subscribe-to-import-mutation-events"]},{"type":"array","items":{"type":"string","enum":["subscribe-to-creation-events","subscribe-to-update-events","subscribe-to-deletion-events","subscribe-to-import-mutation-events"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-profiles"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-cert","reveal-acme-eab-secret","rotate-acme-eab-secret","manage-application-attachments"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-cert","reveal-acme-eab-secret","rotate-acme-eab-secret","manage-application-attachments"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"slug":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-policies"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$glob":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-application"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","list","create"]},{"type":"array","items":{"type":"string","enum":["read","list","create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-authorities"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-ca-certificate","sign-intermediate"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-ca-certificate","sign-intermediate"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificates"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","read-private-key","import"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","read-private-key","import"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"commonName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"altNames":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"serialNumber":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"friendlyName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"status":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"metadata":{"type":"object","properties":{"$elemMatch":{"type":"object","properties":{"key":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"value":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}},"additionalProperties":false}},"required":["$elemMatch"],"additionalProperties":false}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-certificate-authorities"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-certificates"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-certificate-templates"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-hosts"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-host-groups"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["mcp-endpoints"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["mcp-servers"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["mcp-activity-logs"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-approval"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-rollback"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create"]},{"type":"array","items":{"type":"string","enum":["read","create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["member"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"userEmail":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableRole":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"assignableSubject":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableAction":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["groups"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"groupName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableRole":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["role"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["integrations"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["webhooks"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["service-tokens"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["settings"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-validation-rules"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["environments"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["tags"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["audit-logs"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","edit"]},{"type":"array","items":{"type":"string","enum":["read","edit"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["insights"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","generate-report","delete-report"]},{"type":"array","items":{"type":"string","enum":["read","generate-report","delete-report"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ip-allowlist"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-alerts"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-collections"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-inventory-views"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-discovery"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","run-scan"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","run-scan"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-certificate-installations"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["code-signers"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","sign"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","sign"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["workspace"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["edit","delete"]},{"type":"array","items":{"type":"string","enum":["edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kms"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["edit"]},{"type":"array","items":{"type":"string","enum":["edit"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["cmek"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","encrypt","decrypt","sign","verify","generate-mac","verify-mac","rotate","export-private-key"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","encrypt","decrypt","sign","verify","generate-mac","verify-mac","rotate","export-private-key"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kmip"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create-clients","update-clients","delete-clients","read-clients","generate-client-certificates"]},{"type":"array","items":{"type":"string","enum":["create-clients","update-clients","delete-clients","read-clients","generate-client-certificates"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["commits"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","perform-rollback"]},{"type":"array","items":{"type":"string","enum":["read","perform-rollback"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning-data-sources"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-data-sources","create-data-sources","edit-data-sources","delete-data-sources","trigger-data-source-scans","read-data-source-scans","read-data-source-resources"]},{"type":"array","items":{"type":"string","enum":["read-data-sources","create-data-sources","edit-data-sources","delete-data-sources","trigger-data-source-scans","read-data-source-scans","read-data-source-resources"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning-findings"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-findings","update-findings"]},{"type":"array","items":{"type":"string","enum":["read-findings","update-findings"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning-configs"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-configs","update-configs"]},{"type":"array","items":{"type":"string","enum":["read-configs","update-configs"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["app-connections"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read-app-connections","create-app-connections","edit-app-connections","delete-app-connections","connect-app-connections","rotate-credentials"]},{"type":"array","items":{"type":"string","enum":["read-app-connections","create-app-connections","edit-app-connections","delete-app-connections","connect-app-connections","rotate-credentials"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["hsm-connectors"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-hsm-connectors","create-hsm-connectors","edit-hsm-connectors","delete-hsm-connectors","test-hsm-connectors","attach-hsm-connectors"]},{"type":"array","items":{"type":"string","enum":["read-hsm-connectors","create-hsm-connectors","edit-hsm-connectors","delete-hsm-connectors","test-hsm-connectors","attach-hsm-connectors"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["honey-tokens"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","read-credentials","create","edit","reset","revoke"]},{"type":"array","items":{"type":"string","enum":["read","read-credentials","create","edit","reset","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["proxied-services"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","proxy","report-usage"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","proxy","report-usage"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["agent-vault-access-bundles"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","manage-members"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","manage-members"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["agent-vault-sessions"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","revoke"]},{"type":"array","items":{"type":"string","enum":["read","create","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["agent-vault-proxies"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-token","revoke"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-token","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["approval-requests"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create"]},{"type":"array","items":{"type":"string","enum":["read","create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["approval-request-grants"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","revoke"]},{"type":"array","items":{"type":"string","enum":["read","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-approval-request"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read"]},{"type":"array","items":{"type":"string","enum":["read"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["project-folder-grant"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read-grant","create-grant","revoke-grant"]},{"type":"array","items":{"type":"string","enum":["read-grant","create-grant","revoke-grant"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false}]},"description":"The permissions assigned to the role."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to update the role for."},{"schema":{"type":"string"},"in":"path","name":"roleId","required":true,"description":"The ID of the role to update"}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"slug":{"type":"string"},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"}},"required":["id","name","slug","permissions","createdAt","updatedAt","projectId"],"additionalProperties":false}},"required":["role"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["Project Roles"],"description":"Delete a project role","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to delete the role for."},{"schema":{"type":"string"},"in":"path","name":"roleId","required":true,"description":"The ID of the role to update"}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"slug":{"type":"string"},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"}},"required":["id","name","slug","permissions","createdAt","updatedAt","projectId"],"additionalProperties":false}},"required":["role"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/roles/slug/{roleSlug}":{"get":{"tags":["Project Roles"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project."},{"schema":{"type":"string"},"in":"path","name":"roleSlug","required":true,"description":"The slug of the role to get details."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"slug":{"type":"string"},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"}},"required":["id","name","slug","permissions","createdAt","updatedAt","projectId"],"additionalProperties":false}},"required":["role"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/roles/{roleId}":{"get":{"tags":["Project Roles"],"description":"Get a project role by ID","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"roleId","required":true,"description":"The ID of the role to get."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"slug":{"type":"string"},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"}},"required":["id","name","slug","permissions","createdAt","updatedAt","projectId"],"additionalProperties":false}},"required":["role"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/dynamic-secrets":{"post":{"tags":["Dynamic Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectSlug":{"type":"string","minLength":1,"description":"The slug of the project to create dynamic secret in."},"provider":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["sql-database"]},"inputs":{"type":"object","properties":{"client":{"type":"string","enum":["postgres","mysql2","oracledb","mssql","sap-ase","vertica"]},"host":{"type":"string"},"port":{"type":"number"},"database":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"passwordRequirements":{"type":"object","properties":{"length":{"type":"number","minimum":1,"maximum":250},"required":{"type":"object","properties":{"lowercase":{"type":"number","minimum":0},"uppercase":{"type":"number","minimum":0},"digits":{"type":"number","minimum":0},"symbols":{"type":"number","minimum":0}},"required":["lowercase","uppercase","digits","symbols"],"additionalProperties":false},"allowedSymbols":{"type":"string"}},"required":["length","required"],"additionalProperties":false,"description":"Password generation requirements"},"creationStatement":{"type":"string"},"revocationStatement":{"type":"string"},"renewStatement":{"type":"string"},"ca":{"type":"string"},"sslEnabled":{"type":"boolean"},"sslRejectUnauthorized":{"type":"boolean","default":true},"gatewayId":{"type":"string","nullable":true},"gatewayPoolId":{"type":"string","nullable":true}},"required":["client","host","port","database","username","password","creationStatement","revocationStatement"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["clickhouse"]},"inputs":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"number"},"database":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"passwordRequirements":{"type":"object","properties":{"length":{"type":"number","minimum":1,"maximum":250},"required":{"type":"object","properties":{"lowercase":{"type":"number","minimum":0},"uppercase":{"type":"number","minimum":0},"digits":{"type":"number","minimum":0},"symbols":{"type":"number","minimum":0}},"required":["lowercase","uppercase","digits","symbols"],"additionalProperties":false},"allowedSymbols":{"type":"string"}},"required":["length","required"],"additionalProperties":false,"description":"Password generation requirements"},"creationStatement":{"type":"string"},"revocationStatement":{"type":"string"},"renewStatement":{"type":"string"},"ca":{"type":"string"},"gatewayId":{"type":"string","nullable":true},"gatewayPoolId":{"type":"string","nullable":true}},"required":["host","port","database","username","password","creationStatement","revocationStatement"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["cassandra"]},"inputs":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"number"},"localDataCenter":{"type":"string","minLength":1},"keyspace":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"creationStatement":{"type":"string"},"revocationStatement":{"type":"string"},"renewStatement":{"type":"string"},"ca":{"type":"string"},"sslRejectUnauthorized":{"type":"boolean","default":true}},"required":["host","port","localDataCenter","username","password","creationStatement","revocationStatement"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sap-ase"]},"inputs":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"number"},"database":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"creationStatement":{"type":"string"},"revocationStatement":{"type":"string"}},"required":["host","port","database","username","password","creationStatement","revocationStatement"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["aws-iam"]},"inputs":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["access-key"]},"credentialType":{"type":"string","enum":["iam-user","temporary-credentials"],"default":"iam-user"},"accessKey":{"type":"string","minLength":1},"secretAccessKey":{"type":"string","minLength":1},"region":{"type":"string","minLength":1},"awsPath":{"type":"string"},"permissionBoundaryPolicyArn":{"type":"string"},"policyDocument":{"type":"string"},"userGroups":{"type":"string"},"policyArns":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}}},"required":["method","accessKey","secretAccessKey","region"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["assume-role"]},"credentialType":{"type":"string","enum":["iam-user","temporary-credentials"],"default":"iam-user"},"roleArn":{"type":"string","minLength":1},"region":{"type":"string","minLength":1},"awsPath":{"type":"string"},"permissionBoundaryPolicyArn":{"type":"string"},"policyDocument":{"type":"string"},"userGroups":{"type":"string"},"policyArns":{"type":"string"},"sessionPolicyArns":{"type":"string"},"sessionPolicyDocument":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}}},"required":["method","roleArn","region"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["irsa"]},"credentialType":{"type":"string","enum":["iam-user","temporary-credentials"],"default":"iam-user"},"region":{"type":"string","minLength":1},"awsPath":{"type":"string"},"permissionBoundaryPolicyArn":{"type":"string"},"policyDocument":{"type":"string"},"userGroups":{"type":"string"},"policyArns":{"type":"string"},"tags":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}}},"required":["method","region"],"additionalProperties":false}]}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["redis"]},"inputs":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"number"},"username":{"type":"string"},"password":{"type":"string"},"creationStatement":{"type":"string"},"revocationStatement":{"type":"string"},"renewStatement":{"type":"string"},"ca":{"type":"string"},"sslRejectUnauthorized":{"type":"boolean","default":true}},"required":["host","port","username","creationStatement","revocationStatement"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sap-hana"]},"inputs":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"number"},"username":{"type":"string"},"password":{"type":"string"},"creationStatement":{"type":"string"},"revocationStatement":{"type":"string"},"renewStatement":{"type":"string"},"ca":{"type":"string"},"sslRejectUnauthorized":{"type":"boolean","default":true}},"required":["host","port","username","password","creationStatement","revocationStatement"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["aws-elasticache"]},"inputs":{"type":"object","properties":{"clusterName":{"type":"string","minLength":1},"accessKeyId":{"type":"string","minLength":1},"secretAccessKey":{"type":"string","minLength":1},"region":{"type":"string"},"creationStatement":{"type":"string"},"revocationStatement":{"type":"string"}},"required":["clusterName","accessKeyId","secretAccessKey","region","creationStatement","revocationStatement"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["aws-memorydb"]},"inputs":{"type":"object","properties":{"clusterName":{"type":"string","minLength":1},"auth":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["iam"]},"accessKeyId":{"type":"string","minLength":1},"secretAccessKey":{"type":"string","minLength":1}},"required":["type","accessKeyId","secretAccessKey"],"additionalProperties":false}]},"region":{"type":"string","minLength":1},"creationStatement":{"type":"string"},"revocationStatement":{"type":"string"}},"required":["clusterName","auth","region","creationStatement","revocationStatement"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["mongo-db-atlas"]},"inputs":{"type":"object","properties":{"adminPublicKey":{"type":"string","minLength":1,"description":"Admin user public api key"},"adminPrivateKey":{"type":"string","minLength":1,"description":"Admin user private api key"},"groupId":{"type":"string","minLength":1,"description":"Unique 24-hexadecimal digit string that identifies your project. This is same as project id"},"roles":{"type":"array","items":{"type":"object","properties":{"collectionName":{"type":"string","description":"Collection on which this role applies."},"databaseName":{"type":"string","minLength":1,"description":"Database to which the user is granted access privileges."},"roleName":{"type":"string","minLength":1,"description":" Enum: \"atlasAdmin\" \"backup\" \"clusterMonitor\" \"dbAdmin\" \"dbAdminAnyDatabase\" \"enableSharding\" \"read\" \"readAnyDatabase\" \"readWrite\" \"readWriteAnyDatabase\" \"<a custom role name>\".Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role."}},"required":["databaseName","roleName"],"additionalProperties":false},"minItems":1},"scopes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access."},"type":{"type":"string","minLength":1,"description":"Category of resource that this database user can access. Enum: CLUSTER, DATA_LAKE, STREAM"}},"required":["name","type"],"additionalProperties":false}}},"required":["adminPublicKey","adminPrivateKey","groupId","roles","scopes"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["elastic-search"]},"inputs":{"type":"object","properties":{"host":{"type":"string","minLength":1},"port":{"type":"number"},"roles":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"auth":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"username":{"type":"string"},"password":{"type":"string"}},"required":["type","username","password"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["api-key"]},"apiKey":{"type":"string"},"apiKeyId":{"type":"string"}},"required":["type","apiKey","apiKeyId"],"additionalProperties":false}]},"ca":{"type":"string"},"sslRejectUnauthorized":{"type":"boolean","default":true}},"required":["host","port","roles","auth"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["mongo-db"]},"inputs":{"type":"object","properties":{"host":{"type":"string","minLength":1},"port":{"type":"number","nullable":true},"username":{"type":"string","minLength":1},"password":{"type":"string","minLength":1},"database":{"type":"string","minLength":1},"ca":{"type":"string","nullable":true},"sslRejectUnauthorized":{"type":"boolean","default":true},"roles":{"type":"array","items":{"type":"string"},"minItems":1,"description":"Enum: \"atlasAdmin\" \"backup\" \"clusterMonitor\" \"dbAdmin\" \"dbAdminAnyDatabase\" \"enableSharding\" \"read\" \"readAnyDatabase\" \"readWrite\" \"readWriteAnyDatabase\" \"<a custom role name>\".Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role."}},"required":["host","username","password","database","roles"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["rabbit-mq"]},"inputs":{"type":"object","properties":{"host":{"type":"string","minLength":1},"port":{"type":"number"},"tags":{"type":"array","items":{"type":"string"},"default":[]},"username":{"type":"string","minLength":1},"password":{"type":"string","minLength":1},"ca":{"type":"string"},"sslRejectUnauthorized":{"type":"boolean","default":true},"virtualHost":{"type":"object","properties":{"name":{"type":"string","minLength":1},"permissions":{"type":"object","properties":{"read":{"type":"string","minLength":1},"write":{"type":"string","minLength":1},"configure":{"type":"string","minLength":1}},"required":["read","write","configure"],"additionalProperties":false}},"required":["name","permissions"],"additionalProperties":false}},"required":["host","port","username","password","virtualHost"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["azure-entra-id"]},"inputs":{"type":"object","properties":{"tenantId":{"type":"string","minLength":1},"userId":{"type":"string","minLength":1},"email":{"type":"string","minLength":1},"applicationId":{"type":"string","minLength":1},"clientSecret":{"type":"string","minLength":1}},"required":["tenantId","userId","email","applicationId","clientSecret"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["azure-sql-database"]},"inputs":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"number"},"database":{"type":"string"},"masterDatabase":{"type":"string","default":"master"},"username":{"type":"string"},"password":{"type":"string"},"passwordRequirements":{"type":"object","properties":{"length":{"type":"number","minimum":1,"maximum":250},"required":{"type":"object","properties":{"lowercase":{"type":"number","minimum":0},"uppercase":{"type":"number","minimum":0},"digits":{"type":"number","minimum":0},"symbols":{"type":"number","minimum":0}},"required":["lowercase","uppercase","digits","symbols"],"additionalProperties":false},"allowedSymbols":{"type":"string"}},"required":["length","required"],"additionalProperties":false,"description":"Password generation requirements"},"masterCreationStatement":{"type":"string"},"creationStatement":{"type":"string"},"revocationStatement":{"type":"string"},"renewStatement":{"type":"string"},"ca":{"type":"string"},"sslEnabled":{"type":"boolean"},"sslRejectUnauthorized":{"type":"boolean","default":true},"gatewayId":{"type":"string","nullable":true},"gatewayPoolId":{"type":"string","nullable":true}},"required":["host","port","database","username","password","masterCreationStatement","creationStatement","revocationStatement"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["ldap"]},"inputs":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","minLength":1},"binddn":{"type":"string","minLength":1},"bindpass":{"type":"string","minLength":1},"ca":{"type":"string"},"sslRejectUnauthorized":{"type":"boolean","default":true},"credentialType":{"type":"string","enum":["dynamic"],"default":"dynamic"},"creationLdif":{"type":"string","minLength":1},"revocationLdif":{"type":"string","minLength":1},"rollbackLdif":{"type":"string"}},"required":["url","binddn","bindpass","creationLdif","revocationLdif"],"additionalProperties":false},{"type":"object","properties":{"url":{"type":"string","minLength":1},"binddn":{"type":"string","minLength":1},"bindpass":{"type":"string","minLength":1},"ca":{"type":"string"},"sslRejectUnauthorized":{"type":"boolean","default":true},"credentialType":{"type":"string","enum":["static"]},"rotationLdif":{"type":"string","minLength":1}},"required":["url","binddn","bindpass","credentialType","rotationLdif"],"additionalProperties":false}]}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["snowflake"]},"inputs":{"type":"object","properties":{"accountId":{"type":"string","minLength":1},"orgId":{"type":"string","minLength":1},"username":{"type":"string","minLength":1},"password":{"type":"string","minLength":1},"creationStatement":{"type":"string","minLength":1},"revocationStatement":{"type":"string","minLength":1},"renewStatement":{"type":"string"}},"required":["accountId","orgId","username","password","creationStatement","revocationStatement"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["totp"]},"inputs":{"anyOf":[{"type":"object","properties":{"configType":{"type":"string","enum":["url"]},"url":{"type":"string","format":"uri","minLength":1}},"required":["configType","url"],"additionalProperties":false},{"type":"object","properties":{"configType":{"type":"string","enum":["manual"]},"secret":{"type":"string","minLength":1},"period":{"type":"number"},"algorithm":{"type":"string","enum":["sha1","sha256","sha512"]},"digits":{"type":"number"}},"required":["configType","secret"],"additionalProperties":false}]}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["kubernetes"]},"inputs":{"anyOf":[{"type":"object","properties":{"url":{"type":"string"},"clusterToken":{"type":"string"},"ca":{"type":"string"},"sslEnabled":{"type":"boolean","default":false},"sslRejectUnauthorized":{"type":"boolean","default":true},"credentialType":{"type":"string","enum":["static"]},"serviceAccountName":{"type":"string","minLength":1},"namespace":{"type":"string","minLength":1},"gatewayId":{"type":"string","nullable":true},"gatewayPoolId":{"type":"string","nullable":true},"audiences":{"type":"array","items":{"type":"string","minLength":1}},"authMethod":{"type":"string","enum":["gateway","api"],"default":"api"}},"required":["credentialType","serviceAccountName","namespace","audiences"],"additionalProperties":false},{"type":"object","properties":{"url":{"type":"string","format":"uri"},"clusterToken":{"type":"string"},"ca":{"type":"string"},"sslEnabled":{"type":"boolean","default":false},"sslRejectUnauthorized":{"type":"boolean","default":true},"credentialType":{"type":"string","enum":["dynamic"]},"namespace":{"type":"string","minLength":1},"gatewayId":{"type":"string","nullable":true},"gatewayPoolId":{"type":"string","nullable":true},"audiences":{"type":"array","items":{"type":"string","minLength":1}},"roleType":{"type":"string","enum":["cluster-role","role"]},"role":{"type":"string","minLength":1},"authMethod":{"type":"string","enum":["gateway","api"],"default":"api"}},"required":["credentialType","namespace","audiences","roleType","role"],"additionalProperties":false}]}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["vertica"]},"inputs":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"number"},"username":{"type":"string"},"password":{"type":"string"},"database":{"type":"string"},"gatewayId":{"type":"string","nullable":true},"gatewayPoolId":{"type":"string","nullable":true},"creationStatement":{"type":"string"},"revocationStatement":{"type":"string"},"passwordRequirements":{"type":"object","properties":{"length":{"type":"number","minimum":1,"maximum":250},"required":{"type":"object","properties":{"lowercase":{"type":"number","minimum":0},"uppercase":{"type":"number","minimum":0},"digits":{"type":"number","minimum":0},"symbols":{"type":"number","minimum":0}},"required":["lowercase","uppercase","digits","symbols"],"additionalProperties":false},"allowedSymbols":{"type":"string"}},"required":["length","required"],"additionalProperties":false,"description":"Password generation requirements"}},"required":["host","port","username","password","database","creationStatement","revocationStatement"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["gcp-iam"]},"inputs":{"type":"object","properties":{"serviceAccountEmail":{"type":"string","format":"email","minLength":1,"maxLength":128},"tokenScopes":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"default":["https://www.googleapis.com/auth/iam","https://www.googleapis.com/auth/cloud-platform"],"description":"OAuth scopes for the generated access token."}},"required":["serviceAccountEmail"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["github"]},"inputs":{"type":"object","properties":{"appId":{"type":"number","minimum":1,"description":"The ID of your GitHub App."},"installationId":{"type":"number","minimum":1,"description":"The ID of the GitHub App installation."},"privateKey":{"type":"string","minLength":1,"description":"The private key generated for your GitHub App."}},"required":["appId","installationId","privateKey"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["couchbase"]},"inputs":{"type":"object","properties":{"url":{"type":"string","format":"uri","minLength":1,"description":"Couchbase Cloud API URL"},"orgId":{"type":"string","minLength":1,"description":"Organization ID"},"projectId":{"type":"string","minLength":1,"description":"Project ID"},"clusterId":{"type":"string","minLength":1,"description":"Cluster ID"},"roles":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"description":"Roles to assign to the user"},"buckets":{"anyOf":[{"type":"string","minLength":1,"default":"*"},{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Bucket name"},"scopes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"Scope name"},"collections":{"type":"array","items":{"type":"string","minLength":1},"description":"Collection names"}},"required":["name"],"additionalProperties":false},"description":"Scopes within the bucket"}},"required":["name"],"additionalProperties":false}}],"default":"*","description":"Bucket configuration: '*' for all buckets, scopes, and collections or array of bucket objects with specific scopes and collections"},"passwordRequirements":{"type":"object","properties":{"length":{"type":"number","minimum":8,"maximum":128},"required":{"type":"object","properties":{"lowercase":{"type":"number","minimum":1},"uppercase":{"type":"number","minimum":1},"digits":{"type":"number","minimum":1},"symbols":{"type":"number","minimum":1}},"required":["lowercase","uppercase","digits","symbols"],"additionalProperties":false},"allowedSymbols":{"type":"string"}},"required":["length","required"],"additionalProperties":false,"description":"Password generation requirements for Couchbase"},"auth":{"type":"object","properties":{"apiKey":{"type":"string","minLength":1,"description":"Couchbase Cloud API Key"}},"required":["apiKey"],"additionalProperties":false}},"required":["url","orgId","projectId","clusterId","roles","auth"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["milvus"]},"inputs":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"Milvus endpoint host; uses https when the host includes https:// or a CA is provided, http when the host includes http://, otherwise http (e.g. localhost)."},"port":{"type":"integer","minimum":1,"maximum":65535},"username":{"type":"string","minLength":1,"description":"Admin username used to manage Milvus users and roles"},"password":{"type":"string","minLength":1,"description":"Admin password used to manage Milvus users and roles"},"database":{"type":"string","minLength":1,"default":"default","description":"Default Milvus database used for privilege grants"},"privileges":{"type":"array","items":{"type":"object","properties":{"objectType":{"type":"string","minLength":1,"description":"Milvus object type (e.g. \"Collection\", \"Database\", \"Global\", \"User\", \"Cluster\")"},"objectName":{"type":"string","minLength":1,"default":"*","description":"Name of the target object, or \"*\" to apply to all"},"privilege":{"type":"string","minLength":1,"description":"Milvus privilege name or built-in privilege group (e.g. \"Search\", \"COLL_RO\", \"DB_Admin\")"},"dbName":{"type":"string","minLength":1,"description":"Optional database override for this privilege"}},"required":["objectType","privilege"],"additionalProperties":false},"default":[],"description":"Privileges granted to an ephemeral role bound to the lease user. Leave empty to create the user with only the built-in public role."},"ca":{"type":"string"},"sslRejectUnauthorized":{"type":"boolean","default":true},"gatewayId":{"type":"string","nullable":true},"gatewayPoolId":{"type":"string","nullable":true}},"required":["host","port","username","password"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["ssh"]},"inputs":{"type":"object","properties":{"principals":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_4096","EC_prime256v1","EC_secp384r1","ED25519"],"default":"ED25519"},"caKeyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_4096","EC_prime256v1","EC_secp384r1","ED25519"],"default":"ED25519"}},"required":["principals"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["ibm-api-connect"]},"inputs":{"type":"object","properties":{"clientId":{"type":"string","minLength":1},"clientSecret":{"type":"string","minLength":1},"instanceUrl":{"type":"string","format":"uri","minLength":1},"apiKey":{"type":"string","minLength":1},"orgId":{"type":"string","minLength":1},"catalogId":{"type":"string","minLength":1},"consumerOrgId":{"type":"string","minLength":1},"appId":{"type":"string","minLength":1},"gatewayId":{"type":"string","nullable":true},"gatewayPoolId":{"type":"string","nullable":true}},"required":["clientId","clientSecret","instanceUrl","apiKey","orgId","catalogId","consumerOrgId","appId"],"additionalProperties":false}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["tailscale"]},"inputs":{"anyOf":[{"type":"object","properties":{"authType":{"type":"string","enum":["auth_keys"]},"auth":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["api_key"]},"apiKey":{"type":"string","minLength":1,"description":"Tailscale API access token used to create and revoke keys."}},"required":["method","apiKey"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["oauth"]},"clientId":{"type":"string","minLength":1,"description":"Tailscale OAuth client ID."},"clientSecret":{"type":"string","minLength":1,"description":"Tailscale OAuth client secret."}},"required":["method","clientId","clientSecret"],"additionalProperties":false}]},"tailnet":{"type":"string","minLength":1,"default":"-","description":"Tailnet identifier. Use '-' for the token owner's default tailnet."},"description":{"type":"string","maxLength":50,"description":"Description applied to the created key."},"tags":{"type":"array","items":{"type":"string","minLength":1},"default":[],"description":"ACL tags to attach to devices (e.g. tag:ci). Required when authenticating with an OAuth token."},"reusable":{"type":"boolean","default":false,"description":"Whether the auth key can register multiple devices."},"preauthorized":{"type":"boolean","default":false,"description":"Whether devices registered with the key are pre-authorized."}},"required":["authType","auth"],"additionalProperties":false},{"type":"object","properties":{"authType":{"type":"string","enum":["oauth_keys"]},"auth":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["api_key"]},"apiKey":{"type":"string","minLength":1,"description":"Tailscale API access token used to create and revoke keys."}},"required":["method","apiKey"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["oauth"]},"clientId":{"type":"string","minLength":1,"description":"Tailscale OAuth client ID."},"clientSecret":{"type":"string","minLength":1,"description":"Tailscale OAuth client secret."}},"required":["method","clientId","clientSecret"],"additionalProperties":false}]},"tailnet":{"type":"string","minLength":1,"default":"-","description":"Tailnet identifier. Use '-' for the token owner's default tailnet."},"description":{"type":"string","maxLength":50,"description":"Description applied to the created OAuth client."},"tags":{"type":"array","items":{"type":"string","minLength":1},"default":[],"description":"ACL tags to attach (e.g. tag:ci). Required if scopes include devices:core or auth_keys."},"scopes":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"description":"OAuth scopes granted to the client."}},"required":["authType","auth","scopes"],"additionalProperties":false},{"type":"object","properties":{"authType":{"type":"string","enum":["federated_keys"]},"auth":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["api_key"]},"apiKey":{"type":"string","minLength":1,"description":"Tailscale API access token used to create and revoke keys."}},"required":["method","apiKey"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["oauth"]},"clientId":{"type":"string","minLength":1,"description":"Tailscale OAuth client ID."},"clientSecret":{"type":"string","minLength":1,"description":"Tailscale OAuth client secret."}},"required":["method","clientId","clientSecret"],"additionalProperties":false}]},"tailnet":{"type":"string","minLength":1,"default":"-","description":"Tailnet identifier. Use '-' for the token owner's default tailnet."},"description":{"type":"string","maxLength":50,"description":"Description applied to the created federated identity."},"tags":{"type":"array","items":{"type":"string","minLength":1},"default":[],"description":"ACL tags to attach (e.g. tag:ci). Required if scopes include devices:core or auth_keys."},"scopes":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"description":"OAuth scopes granted to tokens issued via this federated identity."},"issuer":{"type":"string","minLength":1,"description":"HTTPS URL of the OIDC issuer trusted for token exchange."},"subject":{"type":"string","minLength":1,"description":"Pattern matched against the sub claim of the OIDC identity token."},"audience":{"type":"string","description":"Audience for the OIDC token exchange. Tailscale auto-generates one if omitted."}},"required":["authType","auth","scopes","issuer","subject"],"additionalProperties":false}]}},"required":["type","inputs"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["oauth2"]},"inputs":{"anyOf":[{"type":"object","properties":{"grantType":{"type":"string","enum":["client-credentials"]},"tokenUrl":{"type":"string","maxLength":2048,"format":"uri","description":"The authorization server's token endpoint."},"revocationUrl":{"type":"string","maxLength":2048,"format":"uri","description":"The authorization server's RFC 7009 token revocation endpoint."},"clientId":{"type":"string","minLength":1,"maxLength":1024,"description":"The OAuth 2.0 client ID."},"clientAuth":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["client_secret_basic"],"description":"Send the client credentials in an HTTP Basic Authorization header."},"clientSecret":{"type":"string","minLength":1,"maxLength":4096,"description":"The OAuth 2.0 client secret."}},"required":["method","clientSecret"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["client_secret_post"],"description":"Send the client credentials as client_id and client_secret form parameters."},"clientSecret":{"type":"string","minLength":1,"maxLength":4096,"description":"The OAuth 2.0 client secret."}},"required":["method","clientSecret"],"additionalProperties":false}],"description":"How Infisical authenticates the client to the token and revocation endpoints."},"scope":{"type":"string","maxLength":2048,"description":"Space-separated scopes to request. Leave empty to use the client's default scopes."},"extraParams":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":128},"value":{"type":"string","minLength":1,"maxLength":2048}},"required":["key","value"],"additionalProperties":false},"maxItems":20,"default":[],"description":"Additional form parameters sent with the token request, such as audience or resource."}},"required":["grantType","tokenUrl","revocationUrl","clientId","clientAuth"],"additionalProperties":false}]}},"required":["type","inputs"],"additionalProperties":false}],"description":"The type of dynamic secret."},"defaultTTL":{"type":"string","description":"The default TTL that will be applied for all the leases."},"maxTTL":{"type":"string","description":"The maximum limit a TTL can be leases or renewed.","nullable":true},"path":{"type":"string","description":"The path to create the dynamic secret in.","default":"/"},"environmentSlug":{"type":"string","minLength":1,"description":"The slug of the environment to create the dynamic secret in."},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the dynamic secret."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}},"usernameTemplate":{"type":"string","maxLength":255}},"required":["projectSlug","provider","defaultTTL","environmentSlug","name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"dynamicSecret":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number"},"type":{"type":"string"},"defaultTTL":{"type":"string"},"maxTTL":{"type":"string","nullable":true},"folderId":{"type":"string","format":"uuid"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectGatewayId":{"type":"string","format":"uuid","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"usernameTemplate":{"type":"string","nullable":true},"gatewayV2Id":{"type":"string","format":"uuid","nullable":true},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}},"inputs":{}},"required":["id","name","version","type","defaultTTL","folderId","createdAt","updatedAt"],"additionalProperties":false}},"required":["dynamicSecret"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"tags":["Dynamic Secrets"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"projectSlug","required":true,"description":"The slug of the project to create dynamic secret in."},{"schema":{"type":"string","default":"/"},"in":"query","name":"path","required":false,"description":"The path to list folders from."},{"schema":{"type":"string","minLength":1},"in":"query","name":"environmentSlug","required":true,"description":"The slug of the environment to list folders from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"dynamicSecrets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number"},"type":{"type":"string"},"defaultTTL":{"type":"string"},"maxTTL":{"type":"string","nullable":true},"folderId":{"type":"string","format":"uuid"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectGatewayId":{"type":"string","format":"uuid","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"usernameTemplate":{"type":"string","nullable":true},"gatewayV2Id":{"type":"string","format":"uuid","nullable":true},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}}},"required":["id","name","version","type","defaultTTL","folderId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["dynamicSecrets"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/dynamic-secrets/{name}":{"patch":{"tags":["Dynamic Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectSlug":{"type":"string","minLength":1,"description":"The slug of the project to update dynamic secret in."},"path":{"type":"string","default":"/","description":"The path to update the dynamic secret in."},"environmentSlug":{"type":"string","minLength":1,"description":"The slug of the environment to update the dynamic secret in."},"data":{"type":"object","properties":{"inputs":{"description":"The new partial values for the configured provider of the dynamic secret"},"defaultTTL":{"type":"string","description":"The default TTL that will be applied for all the leases."},"maxTTL":{"type":"string","description":"The maximum limit a TTL can be leases or renewed.","nullable":true},"newName":{"type":"string","description":"The new name for the dynamic secret."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}},"usernameTemplate":{"type":"string","maxLength":255,"nullable":true}},"additionalProperties":false}},"required":["projectSlug","environmentSlug","data"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"name","required":true,"description":"The name of the dynamic secret."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"dynamicSecret":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number"},"type":{"type":"string"},"defaultTTL":{"type":"string"},"maxTTL":{"type":"string","nullable":true},"folderId":{"type":"string","format":"uuid"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectGatewayId":{"type":"string","format":"uuid","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"usernameTemplate":{"type":"string","nullable":true},"gatewayV2Id":{"type":"string","format":"uuid","nullable":true},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}},"inputs":{}},"required":["id","name","version","type","defaultTTL","folderId","createdAt","updatedAt"],"additionalProperties":false}},"required":["dynamicSecret"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["Dynamic Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectSlug":{"type":"string","minLength":1,"description":"The slug of the project to delete dynamic secret in."},"path":{"type":"string","default":"/","description":"The path to delete the dynamic secret in."},"environmentSlug":{"type":"string","minLength":1,"description":"The slug of the environment to delete the dynamic secret in."},"isForced":{"type":"boolean","default":false,"description":"A boolean flag to delete the the dynamic secret from Infisical without trying to remove it from external provider. Used when the dynamic secret got modified externally."}},"required":["projectSlug","environmentSlug"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"name","required":true,"description":"The name of the dynamic secret."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"dynamicSecret":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number"},"type":{"type":"string"},"defaultTTL":{"type":"string"},"maxTTL":{"type":"string","nullable":true},"folderId":{"type":"string","format":"uuid"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectGatewayId":{"type":"string","format":"uuid","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"usernameTemplate":{"type":"string","nullable":true},"gatewayV2Id":{"type":"string","format":"uuid","nullable":true},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}}},"required":["id","name","version","type","defaultTTL","folderId","createdAt","updatedAt"],"additionalProperties":false}},"required":["dynamicSecret"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"tags":["Dynamic Secrets"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"projectSlug","required":true,"description":"The slug of the project to create dynamic secret in."},{"schema":{"type":"string","default":"/"},"in":"query","name":"path","required":false,"description":"The path to list folders from."},{"schema":{"type":"string","minLength":1},"in":"query","name":"environmentSlug","required":true,"description":"The slug of the environment to list folders from."},{"schema":{"type":"string","minLength":1},"in":"path","name":"name","required":true,"description":"The name of the dynamic secret."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"dynamicSecret":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number"},"type":{"type":"string"},"defaultTTL":{"type":"string"},"maxTTL":{"type":"string","nullable":true},"folderId":{"type":"string","format":"uuid"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectGatewayId":{"type":"string","format":"uuid","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"usernameTemplate":{"type":"string","nullable":true},"gatewayV2Id":{"type":"string","format":"uuid","nullable":true},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}},"inputs":{}},"required":["id","name","version","type","defaultTTL","folderId","createdAt","updatedAt"],"additionalProperties":false}},"required":["dynamicSecret"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/dynamic-secrets/{name}/leases":{"get":{"tags":["Dynamic Secrets"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"projectSlug","required":true,"description":"The slug of the project to create dynamic secret in."},{"schema":{"type":"string","default":"/"},"in":"query","name":"path","required":false,"description":"The path to list folders from."},{"schema":{"type":"string","minLength":1},"in":"query","name":"environmentSlug","required":true,"description":"The slug of the environment to list folders from."},{"schema":{"type":"string","minLength":1},"in":"path","name":"name","required":true,"description":"The name of the dynamic secret."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"leases":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version":{"type":"number"},"externalEntityId":{"type":"string"},"expireAt":{"type":"string","format":"date-time"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"dynamicSecretId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"config":{"nullable":true}},"required":["id","version","externalEntityId","expireAt","dynamicSecretId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["leases"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/dynamic-secrets/leases":{"post":{"tags":["Dynamic Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"dynamicSecretName":{"type":"string","minLength":1,"description":"The name of the dynamic secret."},"projectSlug":{"type":"string","minLength":1,"description":"The slug of the project of the dynamic secret in."},"ttl":{"type":"string","description":"The lease lifetime TTL. If not provided the default TTL of dynamic secret will be used."},"path":{"type":"string","default":"/","description":"The path of the dynamic secret in."},"environmentSlug":{"type":"string","minLength":1,"description":"The slug of the environment of the dynamic secret in."},"config":{}},"required":["dynamicSecretName","projectSlug","environmentSlug"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"lease":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version":{"type":"number"},"externalEntityId":{"type":"string"},"expireAt":{"type":"string","format":"date-time"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"dynamicSecretId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"config":{"nullable":true}},"required":["id","version","externalEntityId","expireAt","dynamicSecretId","createdAt","updatedAt"],"additionalProperties":false},"dynamicSecret":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number"},"type":{"type":"string"},"defaultTTL":{"type":"string"},"maxTTL":{"type":"string","nullable":true},"folderId":{"type":"string","format":"uuid"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectGatewayId":{"type":"string","format":"uuid","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"usernameTemplate":{"type":"string","nullable":true},"gatewayV2Id":{"type":"string","format":"uuid","nullable":true},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}}},"required":["id","name","version","type","defaultTTL","folderId","createdAt","updatedAt"],"additionalProperties":false},"data":{}},"required":["lease","dynamicSecret"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/dynamic-secrets/leases/{leaseId}":{"delete":{"tags":["Dynamic Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectSlug":{"type":"string","minLength":1,"description":"The slug of the project of the dynamic secret in."},"path":{"type":"string","minLength":1,"default":"/","description":"The path of the dynamic secret in."},"environmentSlug":{"type":"string","minLength":1,"description":"The slug of the environment of the dynamic secret in."},"isForced":{"type":"boolean","default":false,"description":"A boolean flag to delete the the dynamic secret from Infisical without trying to remove it from external provider. Used when the dynamic secret got modified externally."}},"required":["projectSlug","environmentSlug"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"leaseId","required":true,"description":"The ID of the dynamic secret lease."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"lease":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version":{"type":"number"},"externalEntityId":{"type":"string"},"expireAt":{"type":"string","format":"date-time"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"dynamicSecretId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"config":{"nullable":true}},"required":["id","version","externalEntityId","expireAt","dynamicSecretId","createdAt","updatedAt"],"additionalProperties":false}},"required":["lease"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"tags":["Dynamic Secrets"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"projectSlug","required":true,"description":"The slug of the project to create dynamic secret in."},{"schema":{"type":"string","default":"/"},"in":"query","name":"path","required":false,"description":"The path to list folders from."},{"schema":{"type":"string","minLength":1},"in":"query","name":"environmentSlug","required":true,"description":"The slug of the environment to list folders from."},{"schema":{"type":"string","minLength":1},"in":"path","name":"leaseId","required":true,"description":"The ID of the dynamic secret lease."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"lease":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version":{"type":"number"},"externalEntityId":{"type":"string"},"expireAt":{"type":"string","format":"date-time"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"dynamicSecretId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"config":{"nullable":true},"dynamicSecret":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number"},"type":{"type":"string"},"defaultTTL":{"type":"string"},"maxTTL":{"type":"string","nullable":true},"folderId":{"type":"string","format":"uuid"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectGatewayId":{"type":"string","format":"uuid","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"usernameTemplate":{"type":"string","nullable":true},"gatewayV2Id":{"type":"string","format":"uuid","nullable":true},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}}},"required":["id","name","version","type","defaultTTL","folderId","createdAt","updatedAt"],"additionalProperties":false}},"required":["id","version","externalEntityId","expireAt","dynamicSecretId","createdAt","updatedAt","dynamicSecret"],"additionalProperties":false}},"required":["lease"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/dynamic-secrets/leases/{leaseId}/renew":{"post":{"tags":["Dynamic Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ttl":{"type":"string","description":"The renew TTL that gets added with current expiry (ensure it's below max TTL) for a total less than creation time + max TTL."},"projectSlug":{"type":"string","minLength":1,"description":"The slug of the project of the dynamic secret in."},"path":{"type":"string","minLength":1,"default":"/","description":"The path of the dynamic secret in."},"environmentSlug":{"type":"string","minLength":1,"description":"The slug of the environment of the dynamic secret in."}},"required":["projectSlug","environmentSlug"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"leaseId","required":true,"description":"The ID of the dynamic secret lease."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"lease":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version":{"type":"number"},"externalEntityId":{"type":"string"},"expireAt":{"type":"string","format":"date-time"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"dynamicSecretId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"config":{"nullable":true}},"required":["id","version","externalEntityId","expireAt","dynamicSecretId","createdAt","updatedAt"],"additionalProperties":false}},"required":["lease"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/dynamic-secrets/leases/kubernetes":{"post":{"tags":["Dynamic Secrets"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"dynamicSecretName":{"type":"string","minLength":1,"description":"The name of the dynamic secret."},"projectSlug":{"type":"string","minLength":1,"description":"The slug of the project of the dynamic secret in."},"ttl":{"type":"string","description":"The lease lifetime TTL. If not provided the default TTL of dynamic secret will be used."},"path":{"type":"string","default":"/","description":"The path of the dynamic secret in."},"environmentSlug":{"type":"string","minLength":1,"description":"The slug of the environment of the dynamic secret in."},"config":{"type":"object","properties":{"namespace":{"type":"string","minLength":1,"description":"The Kubernetes namespace to create the lease in. If not specified, the first namespace defined in the configuration will be used."}},"additionalProperties":false}},"required":["dynamicSecretName","projectSlug","environmentSlug"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"lease":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version":{"type":"number"},"externalEntityId":{"type":"string"},"expireAt":{"type":"string","format":"date-time"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"dynamicSecretId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"config":{"nullable":true}},"required":["id","version","externalEntityId","expireAt","dynamicSecretId","createdAt","updatedAt"],"additionalProperties":false},"dynamicSecret":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number"},"type":{"type":"string"},"defaultTTL":{"type":"string"},"maxTTL":{"type":"string","nullable":true},"folderId":{"type":"string","format":"uuid"},"status":{"type":"string","nullable":true},"statusDetails":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectGatewayId":{"type":"string","format":"uuid","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"usernameTemplate":{"type":"string","nullable":true},"gatewayV2Id":{"type":"string","format":"uuid","nullable":true},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}}},"required":["id","name","version","type","defaultTTL","folderId","createdAt","updatedAt"],"additionalProperties":false},"data":{}},"required":["lease","dynamicSecret"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/relays":{"get":{"operationId":"getRelays","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"orgId":{"type":"string","format":"uuid","nullable":true},"identityId":{"type":"string","format":"uuid","nullable":true},"name":{"type":"string"},"host":{"type":"string"},"heartbeat":{"type":"string","format":"date-time","nullable":true},"healthAlertedAt":{"type":"string","format":"date-time","nullable":true},"tokenVersion":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","name","host"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/proxied-services":{"post":{"tags":["Proxied Services"],"description":"Create a proxied service","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"description":"The ID of the project to create the proxied service in."},"environment":{"type":"string","minLength":1,"description":"The slug of the environment to create the proxied service in."},"secretPath":{"type":"string","default":"/","description":"The secret path (folder) to create the proxied service in."},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the proxied service."},"hostPattern":{"type":"string","minLength":1,"maxLength":255,"description":"One or more comma-separated host patterns the service applies to, e.g. 'api.stripe.com, *.stripe.com'. Each pattern is host[:port][/path]; a '*.' wildcard matches exactly one label."},"isEnabled":{"type":"boolean","description":"Whether the proxied service is enabled. The agent proxy skips disabled services."},"credentials":{"type":"array","items":{"type":"object","properties":{"secretKey":{"type":"string","minLength":1,"maxLength":255,"description":"The key name of the referenced static secret. The secret must live in the same folder as the service. Provide exactly one of secretKey or dynamicSecretName."},"dynamicSecretName":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the referenced dynamic secret. The dynamic secret must live in the same folder as the service; the agent proxy mints a lease and injects a field from its output. Provide exactly one of secretKey or dynamicSecretName. Referenced by name (like secretKey), so a deleted-then-recreated dynamic secret with the same name re-links automatically."},"dynamicSecretField":{"type":"string","minLength":1,"maxLength":255,"description":"For a dynamic secret credential: which lease output field to inject (e.g. 'DB_PASSWORD', 'TOKEN'). Must be a valid output field for the dynamic secret's provider type."},"role":{"type":"string","enum":["header-rewrite","credential-substitution"],"description":"How the credential is applied: 'header-rewrite' sets an HTTP header on the outbound request; 'credential-substitution' replaces a placeholder value in the request."},"headerName":{"type":"string","minLength":1,"maxLength":255,"description":"For header rewriting: the header to set, e.g. 'Authorization' or 'x-api-key'."},"headerPrefix":{"type":"string","maxLength":255,"description":"For header rewriting: an optional prefix joined to the secret value with a space, e.g. 'Bearer'."},"headerPurpose":{"type":"string","enum":["username","password"],"description":"For HTTP basic auth: 'username' or 'password'. The agent proxy combines the pair into a single 'Authorization: Basic' header. Cannot be combined with headerName or headerPrefix."},"placeholderKey":{"type":"string","minLength":1,"maxLength":255,"description":"For credential substitution: the environment variable name the agent receives."},"placeholderValue":{"type":"string","minLength":1,"maxLength":255,"description":"For credential substitution: the placeholder value the agent proxy swaps for the real secret value on the wire."},"substitutionSurfaces":{"type":"array","items":{"type":"string","enum":["header","path","query","body"]},"minItems":1,"description":"For credential substitution: which request surfaces are scanned for the placeholder. Allowed values: 'header', 'path', 'query', 'body'."}},"required":["role"],"additionalProperties":false},"minItems":1,"description":"The credentials the agent proxy applies to requests matching the host pattern."}},"required":["projectId","environment","name","hostPattern","credentials"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"hostPattern":{"type":"string"},"isEnabled":{"type":"boolean","default":true},"folderId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":"string","format":"date-time","nullable":true},"credentials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"serviceId":{"type":"string","format":"uuid"},"secretKey":{"type":"string","nullable":true},"role":{"type":"string"},"headerName":{"type":"string","nullable":true},"headerPrefix":{"type":"string","nullable":true},"headerPurpose":{"type":"string","nullable":true},"placeholderKey":{"type":"string","nullable":true},"placeholderValue":{"type":"string","nullable":true},"substitutionSurfaces":{"type":"array","items":{"type":"string"},"nullable":true},"dynamicSecretName":{"type":"string","nullable":true},"dynamicSecretField":{"type":"string","nullable":true}},"required":["id","serviceId","role"],"additionalProperties":false}}},"required":["id","name","hostPattern","folderId","createdAt","updatedAt","credentials"],"additionalProperties":false}},"required":["service"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"tags":["Proxied Services"],"description":"List proxied services in a folder. Returns the services the caller can read or proxy through; the canProxy field indicates whether the caller can route traffic through each service.","parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"projectId","required":true,"description":"The ID of the project to list proxied services from."},{"schema":{"type":"string","minLength":1},"in":"query","name":"environment","required":true,"description":"The slug of the environment to list proxied services from."},{"schema":{"type":"string","default":"/"},"in":"query","name":"secretPath","required":false,"description":"The secret path (folder) to list proxied services from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectSlug":{"type":"string"},"services":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"hostPattern":{"type":"string"},"isEnabled":{"type":"boolean","default":true},"folderId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":"string","format":"date-time","nullable":true},"credentials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"serviceId":{"type":"string","format":"uuid"},"secretKey":{"type":"string","nullable":true},"role":{"type":"string"},"headerName":{"type":"string","nullable":true},"headerPrefix":{"type":"string","nullable":true},"headerPurpose":{"type":"string","nullable":true},"placeholderKey":{"type":"string","nullable":true},"placeholderValue":{"type":"string","nullable":true},"substitutionSurfaces":{"type":"array","items":{"type":"string"},"nullable":true},"dynamicSecretName":{"type":"string","nullable":true},"dynamicSecretField":{"type":"string","nullable":true},"callerCanLease":{"type":"boolean"}},"required":["id","serviceId","role"],"additionalProperties":false}},"canProxy":{"type":"boolean"}},"required":["id","name","hostPattern","folderId","createdAt","updatedAt","credentials","canProxy"],"additionalProperties":false}}},"required":["projectSlug","services"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/proxied-services/{serviceId}":{"get":{"tags":["Proxied Services"],"description":"Get a proxied service by ID","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"serviceId","required":true,"description":"The ID of the proxied service."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"hostPattern":{"type":"string"},"isEnabled":{"type":"boolean","default":true},"folderId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":"string","format":"date-time","nullable":true},"credentials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"serviceId":{"type":"string","format":"uuid"},"secretKey":{"type":"string","nullable":true},"role":{"type":"string"},"headerName":{"type":"string","nullable":true},"headerPrefix":{"type":"string","nullable":true},"headerPurpose":{"type":"string","nullable":true},"placeholderKey":{"type":"string","nullable":true},"placeholderValue":{"type":"string","nullable":true},"substitutionSurfaces":{"type":"array","items":{"type":"string"},"nullable":true},"dynamicSecretName":{"type":"string","nullable":true},"dynamicSecretField":{"type":"string","nullable":true},"callerCanLease":{"type":"boolean"}},"required":["id","serviceId","role"],"additionalProperties":false}},"canProxy":{"type":"boolean"}},"required":["id","name","hostPattern","folderId","createdAt","updatedAt","credentials","canProxy"],"additionalProperties":false}},"required":["service"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["Proxied Services"],"description":"Update a proxied service","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The new name of the proxied service."},"hostPattern":{"type":"string","minLength":1,"maxLength":255,"description":"The new comma-separated host patterns."},"isEnabled":{"type":"boolean","description":"Whether the proxied service is enabled. The agent proxy skips disabled services."},"credentials":{"type":"array","items":{"type":"object","properties":{"secretKey":{"type":"string","minLength":1,"maxLength":255,"description":"The key name of the referenced static secret. The secret must live in the same folder as the service. Provide exactly one of secretKey or dynamicSecretName."},"dynamicSecretName":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the referenced dynamic secret. The dynamic secret must live in the same folder as the service; the agent proxy mints a lease and injects a field from its output. Provide exactly one of secretKey or dynamicSecretName. Referenced by name (like secretKey), so a deleted-then-recreated dynamic secret with the same name re-links automatically."},"dynamicSecretField":{"type":"string","minLength":1,"maxLength":255,"description":"For a dynamic secret credential: which lease output field to inject (e.g. 'DB_PASSWORD', 'TOKEN'). Must be a valid output field for the dynamic secret's provider type."},"role":{"type":"string","enum":["header-rewrite","credential-substitution"],"description":"How the credential is applied: 'header-rewrite' sets an HTTP header on the outbound request; 'credential-substitution' replaces a placeholder value in the request."},"headerName":{"type":"string","minLength":1,"maxLength":255,"description":"For header rewriting: the header to set, e.g. 'Authorization' or 'x-api-key'."},"headerPrefix":{"type":"string","maxLength":255,"description":"For header rewriting: an optional prefix joined to the secret value with a space, e.g. 'Bearer'."},"headerPurpose":{"type":"string","enum":["username","password"],"description":"For HTTP basic auth: 'username' or 'password'. The agent proxy combines the pair into a single 'Authorization: Basic' header. Cannot be combined with headerName or headerPrefix."},"placeholderKey":{"type":"string","minLength":1,"maxLength":255,"description":"For credential substitution: the environment variable name the agent receives."},"placeholderValue":{"type":"string","minLength":1,"maxLength":255,"description":"For credential substitution: the placeholder value the agent proxy swaps for the real secret value on the wire."},"substitutionSurfaces":{"type":"array","items":{"type":"string","enum":["header","path","query","body"]},"minItems":1,"description":"For credential substitution: which request surfaces are scanned for the placeholder. Allowed values: 'header', 'path', 'query', 'body'."}},"required":["role"],"additionalProperties":false},"minItems":1,"description":"The new credentials. When provided, the entire credentials collection is replaced; when omitted, existing credentials are left unchanged."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"serviceId","required":true,"description":"The ID of the proxied service to update."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"hostPattern":{"type":"string"},"isEnabled":{"type":"boolean","default":true},"folderId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":"string","format":"date-time","nullable":true},"credentials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"serviceId":{"type":"string","format":"uuid"},"secretKey":{"type":"string","nullable":true},"role":{"type":"string"},"headerName":{"type":"string","nullable":true},"headerPrefix":{"type":"string","nullable":true},"headerPurpose":{"type":"string","nullable":true},"placeholderKey":{"type":"string","nullable":true},"placeholderValue":{"type":"string","nullable":true},"substitutionSurfaces":{"type":"array","items":{"type":"string"},"nullable":true},"dynamicSecretName":{"type":"string","nullable":true},"dynamicSecretField":{"type":"string","nullable":true}},"required":["id","serviceId","role"],"additionalProperties":false}}},"required":["id","name","hostPattern","folderId","createdAt","updatedAt","credentials"],"additionalProperties":false}},"required":["service"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["Proxied Services"],"description":"Delete a proxied service","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"serviceId","required":true,"description":"The ID of the proxied service to delete."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"hostPattern":{"type":"string"},"isEnabled":{"type":"boolean","default":true},"folderId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":"string","format":"date-time","nullable":true}},"required":["id","name","hostPattern","folderId","createdAt","updatedAt"],"additionalProperties":false}},"required":["service"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/proxied-services/slug/{name}":{"get":{"tags":["Proxied Services"],"description":"Get a proxied service by name","parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"projectId","required":true,"description":"The ID of the project the proxied service is in."},{"schema":{"type":"string","minLength":1},"in":"query","name":"environment","required":true,"description":"The slug of the environment the proxied service is in."},{"schema":{"type":"string","default":"/"},"in":"query","name":"secretPath","required":false,"description":"The secret path (folder) the proxied service is in."},{"schema":{"type":"string","minLength":1,"maxLength":64},"in":"path","name":"name","required":true,"description":"The name of the proxied service."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"hostPattern":{"type":"string"},"isEnabled":{"type":"boolean","default":true},"folderId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastUsedAt":{"type":"string","format":"date-time","nullable":true},"credentials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"serviceId":{"type":"string","format":"uuid"},"secretKey":{"type":"string","nullable":true},"role":{"type":"string"},"headerName":{"type":"string","nullable":true},"headerPrefix":{"type":"string","nullable":true},"headerPurpose":{"type":"string","nullable":true},"placeholderKey":{"type":"string","nullable":true},"placeholderValue":{"type":"string","nullable":true},"substitutionSurfaces":{"type":"array","items":{"type":"string"},"nullable":true},"dynamicSecretName":{"type":"string","nullable":true},"dynamicSecretField":{"type":"string","nullable":true},"callerCanLease":{"type":"boolean"}},"required":["id","serviceId","role"],"additionalProperties":false}},"canProxy":{"type":"boolean"}},"required":["id","name","hostPattern","folderId","createdAt","updatedAt","credentials","canProxy"],"additionalProperties":false}},"required":["service"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/acme/profiles/{profileId}/directory":{"get":{"tags":["PKI ACME"],"description":"ACME Directory - provides URLs for the client to make API calls to","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"newNonce":{"type":"string"},"newAccount":{"type":"string"},"newOrder":{"type":"string"},"revokeCert":{"type":"string"},"meta":{"type":"object","properties":{"termsOfService":{"type":"string"},"website":{"type":"string"},"caaIdentities":{"type":"array","items":{"type":"string"}},"externalAccountRequired":{"type":"boolean"}},"additionalProperties":false}},"required":["newNonce","newAccount","newOrder"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/acme/profiles/{profileId}/new-nonce":{"get":{"tags":["PKI ACME"],"description":"ACME New Nonce (GET) - generate a new nonce and return in Replay-Nonce header with 204 No Content","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string","minLength":0,"maxLength":0}}}}}}},"/api/v1/cert-manager/acme/profiles/{profileId}/new-account":{"post":{"tags":["PKI ACME"],"description":"ACME New Account - register a new account or find existing one","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"protected":{"type":"string"},"payload":{"type":"string"},"signature":{"type":"string"}},"required":["protected","payload","signature"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"contact":{"type":"array","items":{"type":"string"}},"orders":{"type":"string"}},"required":["status"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/acme/profiles/{profileId}/accounts/{accountId}":{"post":{"tags":["PKI ACME"],"description":"ACME Account Deactivation","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"protected":{"type":"string"},"payload":{"type":"string"},"signature":{"type":"string"}},"required":["protected","payload","signature"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true},{"schema":{"type":"string"},"in":"path","name":"accountId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"}},"required":["status"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/acme/profiles/{profileId}/new-order":{"post":{"tags":["PKI ACME"],"description":"ACME New Order - apply for a new certificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"protected":{"type":"string"},"payload":{"type":"string"},"signature":{"type":"string"}},"required":["protected","payload","signature"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["pending","ready","processing","valid","invalid"]},"expires":{"type":"string"},"notBefore":{"type":"string"},"notAfter":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"],"additionalProperties":false}},"authorizations":{"type":"array","items":{"type":"string"}},"finalize":{"type":"string"},"certificate":{"type":"string"}},"required":["status","identifiers","authorizations","finalize"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/acme/profiles/{profileId}/orders/{orderId}":{"post":{"tags":["PKI ACME"],"description":"ACME Get Order - return status and details of the order","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"protected":{"type":"string"},"payload":{"type":"string"},"signature":{"type":"string"}},"required":["protected","payload","signature"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"orderId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["pending","ready","processing","valid","invalid"]},"expires":{"type":"string"},"notBefore":{"type":"string"},"notAfter":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"],"additionalProperties":false}},"authorizations":{"type":"array","items":{"type":"string"}},"finalize":{"type":"string"},"certificate":{"type":"string"}},"required":["status","identifiers","authorizations","finalize"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/acme/profiles/{profileId}/orders/{orderId}/finalize":{"post":{"tags":["PKI ACME"],"description":"ACME Finalize Order - finalize cert order by providing CSR","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"protected":{"type":"string"},"payload":{"type":"string"},"signature":{"type":"string"}},"required":["protected","payload","signature"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"orderId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["pending","ready","processing","valid","invalid"]},"expires":{"type":"string"},"notBefore":{"type":"string"},"notAfter":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"],"additionalProperties":false}},"authorizations":{"type":"array","items":{"type":"string"}},"finalize":{"type":"string"},"certificate":{"type":"string"}},"required":["status","identifiers","authorizations","finalize"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/acme/profiles/{profileId}/accounts/{accountId}/orders":{"post":{"tags":["PKI ACME"],"description":"ACME List Orders - get existing orders from current account","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"protected":{"type":"string"},"payload":{"type":"string"},"signature":{"type":"string"}},"required":["protected","payload","signature"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true},{"schema":{"type":"string"},"in":"path","name":"accountId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"orders":{"type":"array","items":{"type":"string"}}},"required":["orders"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/acme/profiles/{profileId}/orders/{orderId}/certificate":{"post":{"tags":["PKI ACME"],"description":"ACME Download Certificate - download certificate when ready","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"protected":{"type":"string"},"payload":{"type":"string"},"signature":{"type":"string"}},"required":["protected","payload","signature"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"orderId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/api/v1/cert-manager/acme/profiles/{profileId}/authorizations/{authzId}":{"post":{"tags":["PKI ACME"],"description":"ACME Identifier Authorization - get authorization info (challenges)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"protected":{"type":"string"},"payload":{"type":"string"},"signature":{"type":"string"}},"required":["protected","payload","signature"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"authzId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["pending","valid","invalid","deactivated","expired","revoked"]},"expires":{"type":"string"},"identifier":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}},"required":["type","value"],"additionalProperties":false},"wildcard":{"type":"boolean"},"challenges":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["http-01","dns-01","tls-alpn-01"]},"url":{"type":"string"},"status":{"type":"string"},"token":{"type":"string"},"validated":{"type":"string"}},"required":["type","url","status","token"],"additionalProperties":false}}},"required":["status","identifier","challenges"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/acme/profiles/{profileId}/authorizations/{authzId}/challenges/{challengeId}":{"post":{"tags":["PKI ACME"],"description":"ACME Respond to Challenge - let ACME server know challenge is ready","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"authzId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"challengeId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["http-01","dns-01","tls-alpn-01"]},"url":{"type":"string"},"status":{"type":"string"},"token":{"type":"string"},"validated":{"type":"string"},"error":{"type":"object","properties":{"type":{"type":"string"},"detail":{"type":"string"},"status":{"type":"number"}},"required":["type","detail","status"],"additionalProperties":false}},"required":["type","url","status","token"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/acme/applications/{applicationId}/profiles/{profileId}/directory":{"get":{"tags":["PKI ACME"],"description":"ACME Directory - provides URLs for the client to make API calls to","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"newNonce":{"type":"string"},"newAccount":{"type":"string"},"newOrder":{"type":"string"},"revokeCert":{"type":"string"},"meta":{"type":"object","properties":{"termsOfService":{"type":"string"},"website":{"type":"string"},"caaIdentities":{"type":"array","items":{"type":"string"}},"externalAccountRequired":{"type":"boolean"}},"additionalProperties":false}},"required":["newNonce","newAccount","newOrder"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/acme/applications/{applicationId}/profiles/{profileId}/new-account":{"post":{"tags":["PKI ACME"],"description":"ACME New Account - register a new account or find existing one","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"protected":{"type":"string"},"payload":{"type":"string"},"signature":{"type":"string"}},"required":["protected","payload","signature"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"201":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"contact":{"type":"array","items":{"type":"string"}},"orders":{"type":"string"}},"required":["status"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/discovery-jobs/config":{"get":{"operationId":"getPkiDiscoveryConfig","tags":["PKI Discovery"],"description":"Get PKI discovery configuration limits and defaults","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"defaultPorts":{"type":"string"},"maxPorts":{"type":"number"},"maxIps":{"type":"number"},"maxDomains":{"type":"number"},"minCidrPrefix":{"type":"number"}},"required":["defaultPorts","maxPorts","maxIps","maxDomains","minCidrPrefix"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/discovery-jobs":{"post":{"operationId":"createPkiDiscovery","tags":["PKI Discovery"],"description":"Create a new PKI discovery configuration","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Name of the discovery configuration"},"description":{"type":"string","maxLength":255,"description":"Description of the discovery configuration"},"discoveryType":{"type":"string","enum":["network"],"default":"network","description":"Type of discovery scan"},"targetConfig":{"type":"object","properties":{"ipRanges":{"type":"array","items":{"type":"string","maxLength":64}},"domains":{"type":"array","items":{"type":"string","maxLength":253}},"ports":{"type":"string","default":"443, 8443, 636, 993, 995"}},"additionalProperties":false,"description":"Target configuration for discovery scans"},"isAutoScanEnabled":{"type":"boolean","default":false,"description":"Enable automatic scheduled scans"},"scanIntervalDays":{"type":"number","minimum":1,"maximum":365,"description":"Interval in days between automatic scans"},"gatewayId":{"type":"string","format":"uuid","description":"Gateway ID for scanning private networks"},"gatewayPoolId":{"type":"string","format":"uuid","description":"Gateway pool ID for scanning private networks"}},"required":["name","targetConfig"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"discoveryType":{"type":"string","default":"network"},"targetConfig":{},"isAutoScanEnabled":{"type":"boolean","default":false},"scanIntervalDays":{"type":"number","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isActive":{"type":"boolean","default":true},"lastScanStatus":{"type":"string","nullable":true},"lastScanJobId":{"type":"string","nullable":true},"lastScanMessage":{"type":"string","nullable":true},"lastScannedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listPkiDiscoveries","tags":["PKI Discovery"],"description":"List PKI discovery configurations for a project","parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"Pagination offset"},{"schema":{"type":"number","minimum":1,"maximum":100,"default":25},"in":"query","name":"limit","required":false,"description":"Pagination limit"},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"Search filter for name or description"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"discoveries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"discoveryType":{"type":"string","default":"network"},"targetConfig":{},"isAutoScanEnabled":{"type":"boolean","default":false},"scanIntervalDays":{"type":"number","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isActive":{"type":"boolean","default":true},"lastScanStatus":{"type":"string","nullable":true},"lastScanJobId":{"type":"string","nullable":true},"lastScanMessage":{"type":"string","nullable":true},"lastScannedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"certificatesFound":{"type":"number"},"installationsFound":{"type":"number"}},"required":["id","name","createdAt","updatedAt","certificatesFound","installationsFound"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["discoveries","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/discovery-jobs/{discoveryId}":{"get":{"operationId":"getPkiDiscovery","tags":["PKI Discovery"],"description":"Get a PKI discovery configuration by ID","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"discoveryId","required":true,"description":"The ID of the discovery configuration"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"discoveryType":{"type":"string","default":"network"},"targetConfig":{},"isAutoScanEnabled":{"type":"boolean","default":false},"scanIntervalDays":{"type":"number","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isActive":{"type":"boolean","default":true},"lastScanStatus":{"type":"string","nullable":true},"lastScanJobId":{"type":"string","nullable":true},"lastScanMessage":{"type":"string","nullable":true},"lastScannedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"linkedInstallationsCount":{"type":"number"},"gatewayName":{"type":"string","nullable":true},"gatewayPoolName":{"type":"string","nullable":true}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePkiDiscovery","tags":["PKI Discovery"],"description":"Update a PKI discovery configuration","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Name of the discovery configuration"},"description":{"type":"string","maxLength":255,"nullable":true,"description":"Description of the discovery configuration"},"targetConfig":{"type":"object","properties":{"ipRanges":{"type":"array","items":{"type":"string","maxLength":64}},"domains":{"type":"array","items":{"type":"string","maxLength":253}},"ports":{"type":"string","default":"443, 8443, 636, 993, 995"}},"additionalProperties":false,"description":"Target configuration for discovery scans"},"isAutoScanEnabled":{"type":"boolean","description":"Enable automatic scheduled scans"},"scanIntervalDays":{"type":"number","minimum":1,"maximum":365,"nullable":true,"description":"Interval in days between automatic scans"},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"Gateway ID for scanning private networks"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"Gateway pool ID for scanning private networks"},"isActive":{"type":"boolean","description":"Whether the discovery configuration is active"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"discoveryId","required":true,"description":"The ID of the discovery configuration"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"discoveryType":{"type":"string","default":"network"},"targetConfig":{},"isAutoScanEnabled":{"type":"boolean","default":false},"scanIntervalDays":{"type":"number","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isActive":{"type":"boolean","default":true},"lastScanStatus":{"type":"string","nullable":true},"lastScanJobId":{"type":"string","nullable":true},"lastScanMessage":{"type":"string","nullable":true},"lastScannedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deletePkiDiscovery","tags":["PKI Discovery"],"description":"Delete a PKI discovery configuration","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"discoveryId","required":true,"description":"The ID of the discovery configuration"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"discoveryType":{"type":"string","default":"network"},"targetConfig":{},"isAutoScanEnabled":{"type":"boolean","default":false},"scanIntervalDays":{"type":"number","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isActive":{"type":"boolean","default":true},"lastScanStatus":{"type":"string","nullable":true},"lastScanJobId":{"type":"string","nullable":true},"lastScanMessage":{"type":"string","nullable":true},"lastScannedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/discovery-jobs/{discoveryId}/scan":{"post":{"operationId":"triggerPkiDiscoveryScan","tags":["PKI Discovery"],"description":"Trigger a manual PKI discovery scan","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"discoveryId","required":true,"description":"The ID of the discovery configuration"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/discovery-jobs/{discoveryId}/latest-scan":{"get":{"operationId":"getPkiDiscoveryLatestScan","tags":["PKI Discovery"],"description":"Get the latest scan for a PKI discovery configuration","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"discoveryId","required":true,"description":"The ID of the discovery configuration"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"discoveryConfigId":{"type":"string","format":"uuid"},"startedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string"},"targetsScannedCount":{"type":"number","default":0},"certificatesFoundCount":{"type":"number","default":0},"installationsFoundCount":{"type":"number","default":0},"errorMessage":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","discoveryConfigId","startedAt","status","createdAt","updatedAt"],"additionalProperties":false,"nullable":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/discovery-jobs/{discoveryId}/scans":{"get":{"operationId":"listPkiDiscoveryScans","tags":["PKI Discovery"],"description":"Get scan history for a PKI discovery configuration","parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"Pagination offset"},{"schema":{"type":"number","minimum":1,"maximum":100,"default":25},"in":"query","name":"limit","required":false,"description":"Pagination limit"},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"discoveryId","required":true,"description":"The ID of the discovery configuration"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"scans":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"discoveryConfigId":{"type":"string","format":"uuid"},"startedAt":{"type":"string","format":"date-time"},"completedAt":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string"},"targetsScannedCount":{"type":"number","default":0},"certificatesFoundCount":{"type":"number","default":0},"installationsFoundCount":{"type":"number","default":0},"errorMessage":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","discoveryConfigId","startedAt","status","createdAt","updatedAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["scans","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/installations":{"get":{"operationId":"listPkiInstallations","tags":["PKI Installations"],"description":"List PKI certificate installations for a project","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"discoveryId","required":false,"description":"Filter by discovery configuration ID"},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"certificateId","required":false,"description":"Filter by certificate ID"},{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"Pagination offset"},{"schema":{"type":"number","minimum":1,"maximum":100,"default":25},"in":"query","name":"limit","required":false,"description":"Pagination limit"},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"Search filter for name, hostname, or IP address"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"installations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"locationType":{"type":"string"},"locationDetails":{},"locationFingerprint":{"type":"string"},"name":{"type":"string","nullable":true},"type":{"type":"string","default":"unknown"},"metadata":{"nullable":true},"lastSeenAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"certificatesCount":{"type":"number"},"primaryCertName":{"type":"string","nullable":true},"discoveryName":{"type":"string","nullable":true}},"required":["id","locationType","locationFingerprint","lastSeenAt","createdAt","updatedAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["installations","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/installations/{installationId}":{"get":{"operationId":"getPkiInstallation","tags":["PKI Installations"],"description":"Get a PKI certificate installation by ID with linked certificates","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"installationId","required":true,"description":"The ID of the installation"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"locationType":{"type":"string"},"locationDetails":{},"locationFingerprint":{"type":"string"},"name":{"type":"string","nullable":true},"type":{"type":"string","default":"unknown"},"metadata":{"nullable":true},"lastSeenAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"discoveryName":{"type":"string","nullable":true},"certificates":{"type":"array","items":{"type":"object","properties":{"certificateId":{"type":"string","format":"uuid"},"firstSeenAt":{"type":"string","format":"date-time"},"lastSeenAt":{"type":"string","format":"date-time"},"commonName":{"type":"string","nullable":true},"serialNumber":{"type":"string","nullable":true},"notBefore":{"type":"string","format":"date-time","nullable":true},"notAfter":{"type":"string","format":"date-time","nullable":true},"status":{"type":"string","nullable":true},"friendlyName":{"type":"string","nullable":true},"fingerprintSha256":{"type":"string","nullable":true},"subjectOrganization":{"type":"string","nullable":true},"subjectOrganizationalUnit":{"type":"string","nullable":true},"subjectCountry":{"type":"string","nullable":true},"subjectState":{"type":"string","nullable":true},"subjectLocality":{"type":"string","nullable":true}},"required":["certificateId","firstSeenAt","lastSeenAt"],"additionalProperties":false}}},"required":["id","locationType","locationFingerprint","lastSeenAt","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePkiInstallation","tags":["PKI Installations"],"description":"Update a PKI certificate installation","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":255,"description":"Name of the installation"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"installationId","required":true,"description":"The ID of the installation"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"locationType":{"type":"string"},"locationDetails":{},"locationFingerprint":{"type":"string"},"name":{"type":"string","nullable":true},"type":{"type":"string","default":"unknown"},"metadata":{"nullable":true},"lastSeenAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","locationType","locationFingerprint","lastSeenAt","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deletePkiInstallation","tags":["PKI Installations"],"description":"Delete a PKI certificate installation","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"installationId","required":true,"description":"The ID of the installation"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"locationType":{"type":"string"},"locationDetails":{},"locationFingerprint":{"type":"string"},"name":{"type":"string","nullable":true},"type":{"type":"string","default":"unknown"},"metadata":{"nullable":true},"lastSeenAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","locationType","locationFingerprint","lastSeenAt","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/sso/config":{"get":{"tags":["SAML SSO"],"description":"Get SAML config","parameters":[{"schema":{"type":"string"},"in":"query","name":"organizationId","required":true,"description":"The ID of the organization to get the SAML config for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization":{"type":"string"},"orgId":{"type":"string"},"authProvider":{"type":"string"},"isActive":{"type":"boolean"},"entryPoint":{"type":"string"},"issuer":{"type":"string"},"cert":{"type":"string"},"lastUsed":{"type":"string","format":"date-time","nullable":true},"enableGroupSync":{"type":"boolean"}},"required":["id","organization","orgId","authProvider","isActive","entryPoint","issuer","cert"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["SAML SSO"],"description":"Create SAML config","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","description":"The ID of the organization to create the SAML config for."},"authProvider":{"type":"string","enum":["okta-saml","azure-saml","jumpcloud-saml","google-saml","keycloak-saml","auth0-saml"],"description":"Authentication provider to use for SAML authentication."},"isActive":{"type":"boolean","description":"Whether to enable or disable this SAML configuration."},"entryPoint":{"type":"string","description":"The entry point for the SAML authentication. This is the URL that the user will be redirected to after they have authenticated with the SAML provider."},"issuer":{"type":"string","description":"The SAML provider issuer URL or entity ID."},"cert":{"type":"string","description":"The certificate to use for SAML authentication."},"enableGroupSync":{"type":"boolean","description":"Whether to enable automatic synchronization of group memberships from the SAML provider to Infisical groups."}},"required":["organizationId","authProvider","isActive","entryPoint","issuer","cert"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"orgId":{"type":"string","format":"uuid"},"isActive":{"type":"boolean"},"lastUsed":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"authProvider":{"type":"string"}},"required":["id","orgId","isActive","createdAt","updatedAt","authProvider"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["SAML SSO"],"description":"Update SAML config","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"authProvider":{"type":"string","enum":["okta-saml","azure-saml","jumpcloud-saml","google-saml","keycloak-saml","auth0-saml"],"description":"Authentication provider to use for SAML authentication."},"isActive":{"type":"boolean","description":"Whether to enable or disable this SAML configuration."},"entryPoint":{"type":"string","description":"The entry point for the SAML authentication. This is the URL that the user will be redirected to after they have authenticated with the SAML provider."},"issuer":{"type":"string","description":"The SAML provider issuer URL or entity ID."},"cert":{"type":"string","description":"The certificate to use for SAML authentication."},"enableGroupSync":{"type":"boolean","description":"Whether to enable automatic synchronization of group memberships from the SAML provider to Infisical groups."},"organizationId":{"type":"string","description":"The ID of the organization to update the SAML config for."}},"required":["organizationId"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"orgId":{"type":"string","format":"uuid"},"isActive":{"type":"boolean"},"lastUsed":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"authProvider":{"type":"string"}},"required":["id","orgId","isActive","createdAt","updatedAt","authProvider"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/sso/oidc/config":{"get":{"tags":["OIDC SSO"],"description":"Get OIDC config","parameters":[{"schema":{"type":"string"},"in":"query","name":"organizationId","required":true,"description":"The ID of the organization to get the OIDC config for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"issuer":{"type":"string","nullable":true},"authorizationEndpoint":{"type":"string","nullable":true},"jwksUri":{"type":"string","nullable":true},"tokenEndpoint":{"type":"string","nullable":true},"userinfoEndpoint":{"type":"string","nullable":true},"configurationType":{"type":"string"},"discoveryURL":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"orgId":{"type":"string","format":"uuid"},"allowedEmailDomains":{"type":"string","nullable":true},"manageGroupMemberships":{"type":"boolean","default":false},"jwtSignatureAlgorithm":{"type":"string","default":"RS256"},"clientId":{"type":"string"},"clientSecret":{"type":"string"}},"required":["id","configurationType","isActive","orgId","clientId","clientSecret"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["OIDC SSO"],"description":"Update OIDC config","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"allowedEmailDomains":{"type":"string","default":"","description":"A list of allowed email domains that users can use to authenticate with. This field is comma separated. Supports wildcards (e.g. *.example.com). Example: 'example.com, *.acme.com'"},"discoveryURL":{"type":"string","description":"The URL of the OIDC discovery endpoint."},"configurationType":{"type":"string","enum":["custom","discoveryURL"],"description":"The configuration type to use for the OIDC configuration."},"issuer":{"type":"string","description":"The issuer for the OIDC configuration. This is only supported when the OIDC configuration type is set to 'custom'."},"authorizationEndpoint":{"type":"string","description":"The endpoint to use for OIDC authorization. This is only supported when the OIDC configuration type is set to 'custom'."},"jwksUri":{"type":"string","description":"The URL of the OIDC JWKS endpoint."},"tokenEndpoint":{"type":"string","description":"The token endpoint to use for OIDC token exchange."},"userinfoEndpoint":{"type":"string","description":"The userinfo endpoint to get user information from the OIDC provider."},"clientId":{"type":"string","description":"The client ID to use for OIDC authentication."},"clientSecret":{"type":"string","description":"The client secret to use for OIDC authentication."},"isActive":{"type":"boolean","description":"Whether to enable or disable this OIDC configuration."},"manageGroupMemberships":{"type":"boolean","description":"Whether to manage group memberships for the OIDC configuration. If enabled, users will automatically be assigned groups when they sign in, based on which groups they are a member of in the OIDC provider."},"jwtSignatureAlgorithm":{"type":"string","enum":["RS256","HS256","RS512","EdDSA"],"description":"The algorithm to use for JWT signature verification."},"organizationId":{"type":"string","description":"The ID of the organization to update the OIDC config for."}},"required":["organizationId"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"issuer":{"type":"string","nullable":true},"authorizationEndpoint":{"type":"string","nullable":true},"configurationType":{"type":"string"},"discoveryURL":{"type":"string","nullable":true},"jwksUri":{"type":"string","nullable":true},"tokenEndpoint":{"type":"string","nullable":true},"userinfoEndpoint":{"type":"string","nullable":true},"orgId":{"type":"string","format":"uuid"},"allowedEmailDomains":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"manageGroupMemberships":{"type":"boolean","default":false}},"required":["id","configurationType","orgId","isActive"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["OIDC SSO"],"description":"Create OIDC config","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"allowedEmailDomains":{"type":"string","default":"","description":"A list of allowed email domains that users can use to authenticate with. This field is comma separated. Supports wildcards (e.g. *.example.com)."},"configurationType":{"type":"string","enum":["custom","discoveryURL"],"description":"The configuration type to use for the OIDC configuration."},"issuer":{"type":"string","default":"","description":"The issuer for the OIDC configuration. This is only supported when the OIDC configuration type is set to 'custom'."},"discoveryURL":{"type":"string","default":"","description":"The URL of the OIDC discovery endpoint."},"authorizationEndpoint":{"type":"string","default":"","description":"The authorization endpoint to use for OIDC authorization. This is only supported when the OIDC configuration type is set to 'custom'."},"jwksUri":{"type":"string","default":"","description":"The URL of the OIDC JWKS endpoint."},"tokenEndpoint":{"type":"string","default":"","description":"The token endpoint to use for OIDC token exchange."},"userinfoEndpoint":{"type":"string","default":"","description":"The userinfo endpoint to get user information from the OIDC provider."},"clientId":{"type":"string","description":"The client ID to use for OIDC authentication."},"clientSecret":{"type":"string","description":"The client secret to use for OIDC authentication."},"isActive":{"type":"boolean","description":"Whether to enable or disable this OIDC configuration."},"organizationId":{"type":"string","description":"The ID of the organization to create the OIDC config for."},"manageGroupMemberships":{"type":"boolean","default":false,"description":"Whether to manage group memberships for the OIDC configuration. If enabled, users will automatically be assigned groups when they sign in, based on which groups they are a member of in the OIDC provider."},"jwtSignatureAlgorithm":{"type":"string","enum":["RS256","HS256","RS512","EdDSA"],"default":"RS256","description":"The algorithm to use for JWT signature verification."}},"required":["configurationType","clientId","clientSecret","isActive","organizationId"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"issuer":{"type":"string","nullable":true},"authorizationEndpoint":{"type":"string","nullable":true},"configurationType":{"type":"string"},"discoveryURL":{"type":"string","nullable":true},"jwksUri":{"type":"string","nullable":true},"tokenEndpoint":{"type":"string","nullable":true},"userinfoEndpoint":{"type":"string","nullable":true},"orgId":{"type":"string","format":"uuid"},"isActive":{"type":"boolean"},"allowedEmailDomains":{"type":"string","nullable":true},"manageGroupMemberships":{"type":"boolean","default":false},"jwtSignatureAlgorithm":{"type":"string","default":"RS256"}},"required":["id","configurationType","orgId","isActive"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/ldap/config":{"get":{"tags":["LDAP SSO"],"description":"Get LDAP config","parameters":[{"schema":{"type":"string"},"in":"query","name":"organizationId","required":true,"description":"The ID of the organization to get the LDAP config for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"organization":{"type":"string"},"isActive":{"type":"boolean"},"url":{"type":"string"},"bindDN":{"type":"string"},"bindPass":{"type":"string"},"uniqueUserAttribute":{"type":"string"},"searchBase":{"type":"string"},"searchFilter":{"type":"string"},"groupSearchBase":{"type":"string"},"groupSearchFilter":{"type":"string"},"caCert":{"type":"string"},"clientCertificate":{"type":"string"},"hasClientKeyCertificate":{"type":"boolean"}},"required":["id","organization","isActive","url","bindDN","bindPass","uniqueUserAttribute","searchBase","searchFilter","groupSearchBase","groupSearchFilter","caCert","clientCertificate","hasClientKeyCertificate"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["LDAP SSO"],"description":"Create LDAP config","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"string","description":"The ID of the organization to create the LDAP config for."},"isActive":{"type":"boolean","description":"Whether to enable or disable this LDAP configuration."},"url":{"type":"string","description":"The LDAP server to connect to such as `ldap://ldap.your-org.com`, `ldaps://ldap.myorg.com:636` (for connection over SSL/TLS), etc."},"bindDN":{"type":"string","description":"The distinguished name of the object to bind when performing the user search such as `cn=infisical,ou=Users,dc=acme,dc=com`"},"bindPass":{"type":"string","description":"The password to use along with Bind DN when performing the user search."},"uniqueUserAttribute":{"type":"string","default":"uidNumber","description":"The attribute to use as the unique identifier of LDAP users such as `sAMAccountName`, `cn`, `uid`, `objectGUID`. If left blank, defaults to uidNumber"},"searchBase":{"type":"string","description":"The base DN to use for the user search such as `ou=Users,dc=acme,dc=com`"},"searchFilter":{"type":"string","default":"(uid={{username}})","description":"The template used to construct the LDAP user search filter such as `(uid={{username}})` uses literal `{{username}}` to have the given username used in the search. The default is `(uid={{username}})` which is compatible with several common directory schemas."},"groupSearchBase":{"type":"string","description":"LDAP search base to use for group membership search such as `ou=Groups,dc=acme,dc=com`"},"groupSearchFilter":{"type":"string","default":"(|(memberUid={{.Username}})(member={{.UserDN}})(uniqueMember={{.UserDN}}))","description":"The template used when constructing the group membership query such as `(&(objectClass=posixGroup)(memberUid={{.Username}}))`. The template can access the following context variables: `[UserDN, UserName]`. The default is `(|(memberUid={{.Username}})(member={{.UserDN}})(uniqueMember={{.UserDN}}))` which is compatible with several common directory schemas."},"caCert":{"type":"string","default":"","description":"The CA certificate to use when verifying the LDAP server certificate."},"clientCertificate":{"type":"string","default":"","description":"PEM-encoded client certificate presented during the TLS handshake for mutual TLS (mTLS). Must be provided together with clientKeyCertificate."},"clientKeyCertificate":{"type":"string","default":"","description":"PEM-encoded private key matching the client certificate, used during the TLS handshake for mutual TLS (mTLS). Must be provided together with clientCertificate."}},"required":["organizationId","isActive","url","bindDN","bindPass","searchBase","groupSearchBase"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"isActive":{"type":"boolean"},"orgId":{"type":"string","format":"uuid"},"id":{"type":"string","format":"uuid"},"url":{"type":"string"},"searchBase":{"type":"string"},"searchFilter":{"type":"string","default":""},"groupSearchBase":{"type":"string","default":""},"uniqueUserAttribute":{"type":"string","default":""},"groupSearchFilter":{"type":"string","default":""}},"required":["updatedAt","createdAt","isActive","orgId","id","url","searchBase"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["LDAP SSO"],"description":"Update LDAP config","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"isActive":{"type":"boolean","description":"Whether to enable or disable this LDAP configuration."},"url":{"type":"string","description":"The LDAP server to connect to such as `ldap://ldap.your-org.com`, `ldaps://ldap.myorg.com:636` (for connection over SSL/TLS), etc."},"bindDN":{"type":"string","description":"The distinguished name of object to bind when performing the user search such as `cn=infisical,ou=Users,dc=acme,dc=com`"},"bindPass":{"type":"string","description":"The password to use along with Bind DN when performing the user search."},"uniqueUserAttribute":{"type":"string","description":"The attribute to use as the unique identifier of LDAP users such as `sAMAccountName`, `cn`, `uid`, `objectGUID`. If left blank, defaults to uidNumber"},"searchBase":{"type":"string","description":"The base DN to use for the user search such as `ou=Users,dc=acme,dc=com`"},"searchFilter":{"type":"string","description":"The template used to construct the LDAP user search filter such as `(uid={{username}})` uses literal `{{username}}` to have the given username used in the search. The default is `(uid={{username}})` which is compatible with several common directory schemas."},"groupSearchBase":{"type":"string","description":"LDAP search base to use for group membership search such as `ou=Groups,dc=acme,dc=com`"},"groupSearchFilter":{"type":"string","description":"The template used when constructing the group membership query such as `(&(objectClass=posixGroup)(memberUid={{.Username}}))`. The template can access the following context variables: `[UserDN, UserName]`. The default is `(|(memberUid={{.Username}})(member={{.UserDN}})(uniqueMember={{.UserDN}}))` which is compatible with several common directory schemas."},"caCert":{"type":"string","description":"The CA certificate to use when verifying the LDAP server certificate."},"clientCertificate":{"type":"string","description":"PEM-encoded client certificate presented during the TLS handshake for mutual TLS (mTLS). Must be provided together with clientKeyCertificate."},"clientKeyCertificate":{"type":"string","description":"PEM-encoded private key matching the client certificate, used during the TLS handshake for mutual TLS (mTLS). Must be provided together with clientCertificate."},"organizationId":{"type":"string","description":"The ID of the organization to update the LDAP config for."}},"required":["organizationId"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"isActive":{"type":"boolean"},"orgId":{"type":"string","format":"uuid"},"id":{"type":"string","format":"uuid"},"url":{"type":"string"},"searchBase":{"type":"string"},"searchFilter":{"type":"string","default":""},"groupSearchBase":{"type":"string","default":""},"uniqueUserAttribute":{"type":"string","default":""},"groupSearchFilter":{"type":"string","default":""}},"required":["updatedAt","createdAt","isActive","orgId","id","url","searchBase"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/groups":{"post":{"operationId":"createGroup","tags":["Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the group to create."},"slug":{"type":"string","minLength":5,"maxLength":255,"description":"The slug of the group to create."},"role":{"type":"string","minLength":1,"default":"no-access","description":"The role of the group to create."}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","orgId","name","slug","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listGroups","tags":["Groups"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"role":{"type":"string"},"roleId":{"type":"string","nullable":true}},"required":["id","orgId","name","slug","createdAt","updatedAt","role"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/groups/{id}":{"get":{"operationId":"getGroupById","tags":["Groups"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the group to fetch."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"role":{"type":"string"},"roleId":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true}},"required":["id","orgId","name","slug","createdAt","updatedAt","role","customRoleSlug"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateGroup","tags":["Groups"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"The new name of the group to update to."},"slug":{"type":"string","minLength":5,"maxLength":255,"description":"The new slug of the group to update to."},"role":{"type":"string","minLength":1,"description":"The new role of the group to update to."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the group to update."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","orgId","name","slug","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteGroup","tags":["Groups"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the group to delete."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","orgId","name","slug","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/groups/{id}/users":{"get":{"operationId":"listGroupUsers","tags":["Groups"],"parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th user."},{"schema":{"type":"number","minimum":1,"maximum":100,"default":10},"in":"query","name":"limit","required":false,"description":"The number of users to return."},{"schema":{"type":"string"},"in":"query","name":"username","required":false,"description":"The username to search for."},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"The text string that user email or name will be filtered by."},{"schema":{"type":"string","enum":["existingMembers","nonMembers"]},"in":"query","name":"filter","required":false,"description":"Whether to filter the list of returned users. 'existingMembers' will only return existing users in the group, 'nonMembers' will only return users not in the group, undefined will return all users in the organization."},{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the group to list users for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","nullable":true},"username":{"type":"string"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"id":{"type":"string","format":"uuid"},"isPartOfGroup":{"type":"boolean"},"joinedGroupAt":{"type":"string","format":"date-time","nullable":true}},"required":["username","id","isPartOfGroup","joinedGroupAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["users","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/groups/{id}/machine-identities":{"get":{"operationId":"listGroupMachineIdentities","tags":["Groups"],"parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th identity."},{"schema":{"type":"number","minimum":1,"maximum":100,"default":10},"in":"query","name":"limit","required":false,"description":"The number of identities to return."},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"The text string that machine identity name will be filtered by."},{"schema":{"type":"string","enum":["assignedMachineIdentities","nonAssignedMachineIdentities"]},"in":"query","name":"filter","required":false,"description":"Whether to filter the list of returned identities. 'assignedMachineIdentities' will only return identities assigned to the group, 'nonAssignedMachineIdentities' will only return identities not assigned to the group, undefined will return all identities in the organization."},{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the group to list identities for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"machineIdentities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"isPartOfGroup":{"type":"boolean"},"joinedGroupAt":{"type":"string","format":"date-time","nullable":true}},"required":["id","name","isPartOfGroup","joinedGroupAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["machineIdentities","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/groups/{id}/members":{"get":{"operationId":"listGroupMembers","tags":["Groups"],"parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th member."},{"schema":{"type":"number","minimum":1,"maximum":100,"default":10},"in":"query","name":"limit","required":false,"description":"The number of members to return."},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"The text string that member email(in case of users) or name(in case of machine identities) will be filtered by."},{"schema":{"type":"string","enum":["name"],"default":"name"},"in":"query","name":"orderBy","required":false,"description":"The column to order members by."},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderDirection","required":false,"description":"The direction to order members in."},{"schema":{"anyOf":[{"type":"string","enum":["users","machineIdentities"]},{"type":"array","items":{"type":"string","enum":["users","machineIdentities"]}}]},"in":"query","name":"memberTypeFilter","required":false,"description":"Filter members by type. Can be a single value ('users' or 'machineIdentities') or an array of values. If not specified, both users and machine identities will be returned."},{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the group to list members for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"joinedGroupAt":{"type":"string","format":"date-time","nullable":true},"type":{"type":"string","enum":["user"]},"user":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string"}},"required":["id","username"],"additionalProperties":false}},"required":["id","joinedGroupAt","type","user"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"joinedGroupAt":{"type":"string","format":"date-time","nullable":true},"type":{"type":"string","enum":["machineIdentity"]},"machineIdentity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["id","joinedGroupAt","type","machineIdentity"],"additionalProperties":false}]}},"totalCount":{"type":"number"}},"required":["members","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/groups/{id}/projects":{"get":{"operationId":"listGroupProjects","tags":["Groups"],"parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th project."},{"schema":{"type":"number","minimum":1,"maximum":100,"default":10},"in":"query","name":"limit","required":false,"description":"The number of projects to return."},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"The text string that project name or slug will be filtered by."},{"schema":{"type":"string","enum":["assignedProjects","unassignedProjects"]},"in":"query","name":"filter","required":false,"description":"Whether to filter the list of returned projects. 'assignedProjects' will only return projects assigned to the group, 'unassignedProjects' will only return projects not assigned to the group, undefined will return all projects in the organization."},{"schema":{"type":"string","enum":["name"],"default":"name"},"in":"query","name":"orderBy","required":false,"description":"The column to order projects by."},{"schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"in":"query","name":"orderDirection","required":false,"description":"The direction to order projects in."},{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the group to list projects for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projects":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"joinedGroupAt":{"type":"string","format":"date-time","nullable":true}},"required":["id","name","slug","type","joinedGroupAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["projects","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/groups/{id}/users/{username}":{"post":{"operationId":"addUserToGroup","tags":["Groups"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the group to add the user to."},{"schema":{"type":"string"},"in":"path","name":"username","required":true,"description":"The username of the user to add to the group."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","nullable":true},"username":{"type":"string"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"id":{"type":"string","format":"uuid"}},"required":["username","id"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removeUserFromGroup","tags":["Groups"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the group to remove the user from."},{"schema":{"type":"string"},"in":"path","name":"username","required":true,"description":"The username of the user to remove from the group."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","nullable":true},"username":{"type":"string"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"id":{"type":"string","format":"uuid"}},"required":["username","id"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/groups/{id}/machine-identities/{machineIdentityId}":{"post":{"operationId":"addMachineIdentityToGroup","tags":["Groups"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the group to add the machine identity to."},{"schema":{"type":"string"},"in":"path","name":"machineIdentityId","required":true,"description":"The ID of the machine identity to add to the group."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removeMachineIdentityFromGroup","tags":["Groups"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the group to remove the machine identity from."},{"schema":{"type":"string"},"in":"path","name":"machineIdentityId","required":true,"description":"The ID of the machine identity to remove from the group."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/additional-privilege/identity/permanent":{"post":{"tags":["Identity Specific Privileges"],"description":"Create a permanent or a non expiry specific privilege for identity.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","minLength":1,"description":"The ID of the machine identity to create."},"projectSlug":{"type":"string","minLength":1,"description":"The slug of the project of the identity in."},"slug":{"type":"string","minLength":1,"maxLength":60,"description":"The slug of the privilege to create."},"permissions":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","enum":["read","create","edit","delete"],"description":"Describe what action an entity can take. Possible actions: create, edit, delete, and read"},"subject":{"type":"string","enum":["role","member","groups","settings","integrations","webhooks","service-tokens","environments","tags","audit-logs","ip-allowlist","workspace","secrets","secret-folders","secret-imports","dynamic-secrets","secret-rollback","secret-approval","secret-approval-request","secret-rotation","commits","identity","certificate-authorities","certificates","certificate-templates","pki-subscribers","pki-alerts","pki-collections","certificate-inventory-views","kms","cmek","secret-syncs","secret-validation-rules","pki-syncs","pki-discovery","pki-certificate-installations","code-signers","kmip","secret-scanning-data-sources","secret-scanning-findings","secret-scanning-configs","secret-event-subscriptions","app-connections","hsm-connectors","certificate-profiles","certificate-policies","certificate-application","approval-requests","approval-request-grants","project-folder-grant","honey-tokens","proxied-services","agent-vault-access-bundles","agent-vault-sessions","agent-vault-proxies","insights"],"description":"The entity this permission pertains to. Possible options: secrets, environments"},"conditions":{"type":"object","properties":{"environment":{"type":"string","description":"The environment slug this permission should allow."},"secretPath":{"type":"object","properties":{"$glob":{"type":"string","minLength":1,"description":"The secret path this permission should allow. Can be a glob pattern such as /folder-name/*/** "}},"required":["$glob"],"additionalProperties":false}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["action","subject"],"additionalProperties":false},"description":"@deprecated - use privilegePermission\nThe permission object for the privilege.\n- Read secrets\n```\n{ \"permissions\": [{\"action\": \"read\", \"subject\": \"secrets\"]}\n```\n- Read and Write secrets\n```\n{ \"permissions\": [{\"action\": \"read\", \"subject\": \"secrets\"], {\"action\": \"write\", \"subject\": \"secrets\"]}\n```\n- Read secrets scoped to an environment and secret path\n```\n- { \"permissions\": [{\"action\": \"read\", \"subject\": \"secrets\", \"conditions\": { \"environment\": \"dev\", \"secretPath\": { \"$glob\": \"/\" } }}] }\n```\n"},"privilegePermission":{"type":"object","properties":{"actions":{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"],"description":"Describe what action an entity can take. Possible actions: create, edit, delete, and read"},"minItems":1},"subject":{"type":"string","enum":["secrets"],"description":"The entity this permission pertains to. Possible options: secrets, environments"},"conditions":{"type":"object","properties":{"environment":{"type":"string","description":"The environment slug this permission should allow."},"secretPath":{"type":"object","properties":{"$glob":{"type":"string","minLength":1,"description":"The secret path this permission should allow. Can be a glob pattern such as /folder-name/*/** "}},"required":["$glob"],"additionalProperties":false}},"required":["environment"],"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["actions","subject","conditions"],"additionalProperties":false,"description":"The permission object for the privilege."}},"required":["identityId","projectSlug"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"privilege":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"projectMembershipId":{"type":"string","format":"uuid"},"isTemporary":{"type":"boolean","default":false},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","slug","projectMembershipId","permissions","createdAt","updatedAt"],"additionalProperties":false}},"required":["privilege"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/additional-privilege/identity/temporary":{"post":{"tags":["Identity Specific Privileges"],"description":"Create a temporary or a expiring specific privilege for identity.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","minLength":1,"description":"The ID of the machine identity to create."},"projectSlug":{"type":"string","minLength":1,"description":"The slug of the project of the identity in."},"slug":{"type":"string","minLength":1,"maxLength":60,"description":"The slug of the privilege to create."},"permissions":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","enum":["read","create","edit","delete"],"description":"Describe what action an entity can take. Possible actions: create, edit, delete, and read"},"subject":{"type":"string","enum":["role","member","groups","settings","integrations","webhooks","service-tokens","environments","tags","audit-logs","ip-allowlist","workspace","secrets","secret-folders","secret-imports","dynamic-secrets","secret-rollback","secret-approval","secret-approval-request","secret-rotation","commits","identity","certificate-authorities","certificates","certificate-templates","pki-subscribers","pki-alerts","pki-collections","certificate-inventory-views","kms","cmek","secret-syncs","secret-validation-rules","pki-syncs","pki-discovery","pki-certificate-installations","code-signers","kmip","secret-scanning-data-sources","secret-scanning-findings","secret-scanning-configs","secret-event-subscriptions","app-connections","hsm-connectors","certificate-profiles","certificate-policies","certificate-application","approval-requests","approval-request-grants","project-folder-grant","honey-tokens","proxied-services","agent-vault-access-bundles","agent-vault-sessions","agent-vault-proxies","insights"],"description":"The entity this permission pertains to. Possible options: secrets, environments"},"conditions":{"type":"object","properties":{"environment":{"type":"string","description":"The environment slug this permission should allow."},"secretPath":{"type":"object","properties":{"$glob":{"type":"string","minLength":1,"description":"The secret path this permission should allow. Can be a glob pattern such as /folder-name/*/** "}},"required":["$glob"],"additionalProperties":false}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["action","subject"],"additionalProperties":false},"description":"@deprecated - use privilegePermission\nThe permission object for the privilege.\n- Read secrets\n```\n{ \"permissions\": [{\"action\": \"read\", \"subject\": \"secrets\"]}\n```\n- Read and Write secrets\n```\n{ \"permissions\": [{\"action\": \"read\", \"subject\": \"secrets\"], {\"action\": \"write\", \"subject\": \"secrets\"]}\n```\n- Read secrets scoped to an environment and secret path\n```\n- { \"permissions\": [{\"action\": \"read\", \"subject\": \"secrets\", \"conditions\": { \"environment\": \"dev\", \"secretPath\": { \"$glob\": \"/\" } }}] }\n```\n"},"privilegePermission":{"type":"object","properties":{"actions":{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"],"description":"Describe what action an entity can take. Possible actions: create, edit, delete, and read"},"minItems":1},"subject":{"type":"string","enum":["secrets"],"description":"The entity this permission pertains to. Possible options: secrets, environments"},"conditions":{"type":"object","properties":{"environment":{"type":"string","description":"The environment slug this permission should allow."},"secretPath":{"type":"object","properties":{"$glob":{"type":"string","minLength":1,"description":"The secret path this permission should allow. Can be a glob pattern such as /folder-name/*/** "}},"required":["$glob"],"additionalProperties":false}},"required":["environment"],"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["actions","subject","conditions"],"additionalProperties":false,"description":"The permission object for the privilege."},"temporaryMode":{"type":"string","enum":["relative"],"description":"Type of temporary access given. Types: relative."},"temporaryRange":{"type":"string","description":"TTL for the temporary time. Eg: 1m, 1h, 1d."},"temporaryAccessStartTime":{"type":"string","format":"date-time","description":"ISO time for which temporary access should begin."}},"required":["identityId","projectSlug","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"privilege":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"projectMembershipId":{"type":"string","format":"uuid"},"isTemporary":{"type":"boolean","default":false},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","slug","projectMembershipId","permissions","createdAt","updatedAt"],"additionalProperties":false}},"required":["privilege"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/additional-privilege/identity":{"patch":{"tags":["Identity Specific Privileges"],"description":"Update a specific privilege of an identity.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"privilegeSlug":{"type":"string","minLength":1,"description":"The slug of the privilege to update."},"identityId":{"type":"string","minLength":1,"description":"The ID of the machine identity to update."},"projectSlug":{"type":"string","minLength":1,"description":"The slug of the project of the identity in."},"privilegeDetails":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":60,"description":"The new slug of the privilege to update."},"permissions":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string","enum":["read","create","edit","delete"],"description":"Describe what action an entity can take. Possible actions: create, edit, delete, and read"},"subject":{"type":"string","enum":["role","member","groups","settings","integrations","webhooks","service-tokens","environments","tags","audit-logs","ip-allowlist","workspace","secrets","secret-folders","secret-imports","dynamic-secrets","secret-rollback","secret-approval","secret-approval-request","secret-rotation","commits","identity","certificate-authorities","certificates","certificate-templates","pki-subscribers","pki-alerts","pki-collections","certificate-inventory-views","kms","cmek","secret-syncs","secret-validation-rules","pki-syncs","pki-discovery","pki-certificate-installations","code-signers","kmip","secret-scanning-data-sources","secret-scanning-findings","secret-scanning-configs","secret-event-subscriptions","app-connections","hsm-connectors","certificate-profiles","certificate-policies","certificate-application","approval-requests","approval-request-grants","project-folder-grant","honey-tokens","proxied-services","agent-vault-access-bundles","agent-vault-sessions","agent-vault-proxies","insights"],"description":"The entity this permission pertains to. Possible options: secrets, environments"},"conditions":{"type":"object","properties":{"environment":{"type":"string","description":"The environment slug this permission should allow."},"secretPath":{"type":"object","properties":{"$glob":{"type":"string","minLength":1,"description":"The secret path this permission should allow. Can be a glob pattern such as /folder-name/*/** "}},"required":["$glob"],"additionalProperties":false}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["action","subject"],"additionalProperties":false},"description":"@deprecated - use privilegePermission\nThe permission object for the privilege.\n- Read secrets\n```\n{ \"permissions\": [{\"action\": \"read\", \"subject\": \"secrets\"]}\n```\n- Read and Write secrets\n```\n{ \"permissions\": [{\"action\": \"read\", \"subject\": \"secrets\"], {\"action\": \"write\", \"subject\": \"secrets\"]}\n```\n- Read secrets scoped to an environment and secret path\n```\n- { \"permissions\": [{\"action\": \"read\", \"subject\": \"secrets\", \"conditions\": { \"environment\": \"dev\", \"secretPath\": { \"$glob\": \"/\" } }}] }\n```\n"},"privilegePermission":{"type":"object","properties":{"actions":{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"],"description":"Describe what action an entity can take. Possible actions: create, edit, delete, and read"},"minItems":1},"subject":{"type":"string","enum":["secrets"],"description":"The entity this permission pertains to. Possible options: secrets, environments"},"conditions":{"type":"object","properties":{"environment":{"type":"string","description":"The environment slug this permission should allow."},"secretPath":{"type":"object","properties":{"$glob":{"type":"string","minLength":1,"description":"The secret path this permission should allow. Can be a glob pattern such as /folder-name/*/** "}},"required":["$glob"],"additionalProperties":false}},"required":["environment"],"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["actions","subject","conditions"],"additionalProperties":false,"description":"The permission object for the privilege."},"isTemporary":{"type":"boolean","description":"Whether the privilege is temporary."},"temporaryMode":{"type":"string","enum":["relative"],"description":"Type of temporary access given. Types: relative."},"temporaryRange":{"type":"string","description":"TTL for the temporary time. Eg: 1m, 1h, 1d."},"temporaryAccessStartTime":{"type":"string","format":"date-time","description":"ISO time for which temporary access should begin."}},"additionalProperties":false}},"required":["privilegeSlug","identityId","projectSlug","privilegeDetails"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"privilege":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"projectMembershipId":{"type":"string","format":"uuid"},"isTemporary":{"type":"boolean","default":false},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","slug","projectMembershipId","permissions","createdAt","updatedAt"],"additionalProperties":false}},"required":["privilege"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["Identity Specific Privileges"],"description":"Delete a specific privilege of an identity.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"privilegeSlug":{"type":"string","minLength":1,"description":"The slug of the privilege to delete."},"identityId":{"type":"string","minLength":1,"description":"The ID of the machine identity to delete."},"projectSlug":{"type":"string","minLength":1,"description":"The slug of the project of the identity in."}},"required":["privilegeSlug","identityId","projectSlug"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"privilege":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"projectMembershipId":{"type":"string","format":"uuid"},"isTemporary":{"type":"boolean","default":false},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","slug","projectMembershipId","permissions","createdAt","updatedAt"],"additionalProperties":false}},"required":["privilege"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"tags":["Identity Specific Privileges"],"description":"List of a specific privilege of an identity in a project.","parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"identityId","required":true,"description":"The ID of the machine identity to list."},{"schema":{"type":"string","minLength":1},"in":"query","name":"projectSlug","required":true,"description":"The slug of the project of the identity in."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"privileges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"projectMembershipId":{"type":"string","format":"uuid"},"isTemporary":{"type":"boolean","default":false},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","slug","projectMembershipId","permissions","createdAt","updatedAt"],"additionalProperties":false}}},"required":["privileges"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/additional-privilege/identity/{privilegeSlug}":{"get":{"tags":["Identity Specific Privileges"],"description":"Retrieve details of a specific privilege by privilege slug.","parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"identityId","required":true,"description":"The ID of the machine identity to list."},{"schema":{"type":"string","minLength":1},"in":"query","name":"projectSlug","required":true,"description":"The slug of the project of the identity in."},{"schema":{"type":"string","minLength":1},"in":"path","name":"privilegeSlug","required":true,"description":"The slug of the privilege."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"privilege":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"projectMembershipId":{"type":"string","format":"uuid"},"isTemporary":{"type":"boolean","default":false},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","slug","projectMembershipId","permissions","createdAt","updatedAt"],"additionalProperties":false}},"required":["privilege"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/identity-templates":{"post":{"description":"Create identity auth template","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"authMethod":{"type":"string","enum":["ldap"]},"templateFields":{"type":"object","properties":{"url":{"type":"string","minLength":1},"bindDN":{"type":"string","minLength":1},"bindPass":{"type":"string","minLength":1},"searchBase":{"type":"string","minLength":1},"ldapCaCertificate":{"type":"string"}},"required":["url","bindDN","bindPass","searchBase"],"additionalProperties":false}},"required":["name","authMethod","templateFields"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"authMethod":{"type":"string","enum":["kubernetes"]},"templateFields":{"type":"object","properties":{"tokenReviewMode":{"type":"string","enum":["api","gateway"],"default":"api","description":"The mode to use for token review. Must be one of: 'api', 'gateway'"},"kubernetesHost":{"type":"string","minLength":1,"maxLength":255,"nullable":true,"description":"The host string, host:port pair, or URL to the base of the Kubernetes API server"},"caCert":{"type":"string","maxLength":102400,"description":"The PEM-encoded CA certificate used to validate the Kubernetes API server's TLS certificate"},"verifyTlsCertificate":{"type":"boolean","description":"Whether to verify the Kubernetes API server's TLS certificate against the configured CA certificate"},"tokenReviewerJwt":{"type":"string","maxLength":65536,"description":"Optional JWT token for accessing the Kubernetes TokenReview API"},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway to use when performing Kubernetes API requests"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway pool to use when performing Kubernetes API requests"},"allowedAudience":{"type":"string","maxLength":1000,"default":"","description":"The optional audience claim that service account JWT tokens must have to authenticate with Infisical"}},"additionalProperties":false}},"required":["name","authMethod","templateFields"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"authMethod":{"type":"string","enum":["oidc"]},"templateFields":{"type":"object","properties":{"oidcDiscoveryUrl":{"type":"string","format":"uri","minLength":1,"maxLength":2048,"description":"The URL used to retrieve the OpenID Connect configuration from the identity provider"},"boundIssuer":{"type":"string","minLength":1,"maxLength":2048,"description":"The unique identifier of the identity provider issuing the JWT"},"boundAudiences":{"type":"string","maxLength":2048,"default":"","description":"The comma-separated list of intended recipients that JWT tokens must have in their aud claim"},"caCert":{"type":"string","maxLength":102400,"description":"The PEM-encoded CA certificate used to validate the identity provider's TLS certificate"}},"required":["oidcDiscoveryUrl","boundIssuer"],"additionalProperties":false}},"required":["name","authMethod","templateFields"],"additionalProperties":false}]}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"url":{"type":"string","minLength":1},"bindDN":{"type":"string","minLength":1},"searchBase":{"type":"string","minLength":1},"ldapCaCertificate":{"type":"string"},"hasBindPass":{"type":"boolean","description":"Whether a bind password is stored for this template"}},"required":["hasBindPass"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["ldap"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"tokenReviewMode":{"type":"string","enum":["api","gateway"],"default":"api","description":"The mode to use for token review. Must be one of: 'api', 'gateway'"},"kubernetesHost":{"type":"string","minLength":1,"maxLength":255,"nullable":true,"description":"The host string, host:port pair, or URL to the base of the Kubernetes API server"},"caCert":{"type":"string","maxLength":102400,"description":"The PEM-encoded CA certificate used to validate the Kubernetes API server's TLS certificate"},"verifyTlsCertificate":{"type":"boolean","description":"Whether to verify the Kubernetes API server's TLS certificate against the configured CA certificate"},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway to use when performing Kubernetes API requests"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway pool to use when performing Kubernetes API requests"},"allowedAudience":{"type":"string","maxLength":1000,"default":"","description":"The optional audience claim that service account JWT tokens must have to authenticate with Infisical"},"hasTokenReviewerJwt":{"type":"boolean","description":"Whether a token reviewer JWT is stored for this template"}},"required":["hasTokenReviewerJwt"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["kubernetes"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"oidcDiscoveryUrl":{"type":"string","description":"The URL used to retrieve the OpenID Connect configuration from the identity provider"},"boundIssuer":{"type":"string","minLength":1,"maxLength":2048,"description":"The unique identifier of the identity provider issuing the JWT"},"boundAudiences":{"type":"string","default":"","description":"The comma-separated list of intended recipients that JWT tokens must have in their aud claim"},"caCert":{"type":"string","maxLength":102400,"description":"The PEM-encoded CA certificate used to validate the identity provider's TLS certificate"}},"required":["oidcDiscoveryUrl","boundIssuer"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["oidc"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"description":"Get identity auth templates by authentication method","parameters":[{"schema":{"type":"string","enum":["ldap","kubernetes","oidc"]},"in":"query","name":"authMethod","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"url":{"type":"string","minLength":1},"bindDN":{"type":"string","minLength":1},"searchBase":{"type":"string","minLength":1},"ldapCaCertificate":{"type":"string"},"hasBindPass":{"type":"boolean","description":"Whether a bind password is stored for this template"}},"required":["hasBindPass"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["ldap"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"tokenReviewMode":{"type":"string","enum":["api","gateway"],"default":"api","description":"The mode to use for token review. Must be one of: 'api', 'gateway'"},"kubernetesHost":{"type":"string","minLength":1,"maxLength":255,"nullable":true,"description":"The host string, host:port pair, or URL to the base of the Kubernetes API server"},"caCert":{"type":"string","maxLength":102400,"description":"The PEM-encoded CA certificate used to validate the Kubernetes API server's TLS certificate"},"verifyTlsCertificate":{"type":"boolean","description":"Whether to verify the Kubernetes API server's TLS certificate against the configured CA certificate"},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway to use when performing Kubernetes API requests"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway pool to use when performing Kubernetes API requests"},"allowedAudience":{"type":"string","maxLength":1000,"default":"","description":"The optional audience claim that service account JWT tokens must have to authenticate with Infisical"},"hasTokenReviewerJwt":{"type":"boolean","description":"Whether a token reviewer JWT is stored for this template"}},"required":["hasTokenReviewerJwt"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["kubernetes"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"oidcDiscoveryUrl":{"type":"string","description":"The URL used to retrieve the OpenID Connect configuration from the identity provider"},"boundIssuer":{"type":"string","minLength":1,"maxLength":2048,"description":"The unique identifier of the identity provider issuing the JWT"},"boundAudiences":{"type":"string","default":"","description":"The comma-separated list of intended recipients that JWT tokens must have in their aud claim"},"caCert":{"type":"string","maxLength":102400,"description":"The PEM-encoded CA certificate used to validate the identity provider's TLS certificate"}},"required":["oidcDiscoveryUrl","boundIssuer"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["oidc"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false}]}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/identity-templates/{templateId}":{"patch":{"description":"Update identity auth template","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"templateFields":{"type":"object","properties":{"url":{"type":"string","minLength":1},"bindDN":{"type":"string","minLength":1},"bindPass":{"type":"string","minLength":1},"searchBase":{"type":"string","minLength":1},"ldapCaCertificate":{"type":"string"},"tokenReviewMode":{"type":"string","enum":["api","gateway"],"default":"api","description":"The mode to use for token review. Must be one of: 'api', 'gateway'"},"kubernetesHost":{"type":"string","minLength":1,"maxLength":255,"nullable":true,"description":"The host string, host:port pair, or URL to the base of the Kubernetes API server"},"caCert":{"type":"string","maxLength":102400,"description":"The PEM-encoded CA certificate used to validate the TLS certificate of the Kubernetes API server or identity provider"},"verifyTlsCertificate":{"type":"boolean","description":"Whether to verify the Kubernetes API server's TLS certificate against the configured CA certificate"},"tokenReviewerJwt":{"type":"string","maxLength":65536,"description":"Optional JWT token for accessing the Kubernetes TokenReview API"},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway to use when performing Kubernetes API requests"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway pool to use when performing Kubernetes API requests"},"allowedAudience":{"type":"string","maxLength":1000,"default":"","description":"The optional audience claim that service account JWT tokens must have to authenticate with Infisical"},"oidcDiscoveryUrl":{"type":"string","format":"uri","minLength":1,"maxLength":2048,"description":"The URL used to retrieve the OpenID Connect configuration from the identity provider"},"boundIssuer":{"type":"string","minLength":1,"maxLength":2048,"description":"The unique identifier of the identity provider issuing the JWT"},"boundAudiences":{"type":"string","maxLength":2048,"default":"","description":"The comma-separated list of intended recipients that JWT tokens must have in their aud claim"}},"additionalProperties":false}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"templateId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"url":{"type":"string","minLength":1},"bindDN":{"type":"string","minLength":1},"searchBase":{"type":"string","minLength":1},"ldapCaCertificate":{"type":"string"},"hasBindPass":{"type":"boolean","description":"Whether a bind password is stored for this template"}},"required":["hasBindPass"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["ldap"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"tokenReviewMode":{"type":"string","enum":["api","gateway"],"default":"api","description":"The mode to use for token review. Must be one of: 'api', 'gateway'"},"kubernetesHost":{"type":"string","minLength":1,"maxLength":255,"nullable":true,"description":"The host string, host:port pair, or URL to the base of the Kubernetes API server"},"caCert":{"type":"string","maxLength":102400,"description":"The PEM-encoded CA certificate used to validate the Kubernetes API server's TLS certificate"},"verifyTlsCertificate":{"type":"boolean","description":"Whether to verify the Kubernetes API server's TLS certificate against the configured CA certificate"},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway to use when performing Kubernetes API requests"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway pool to use when performing Kubernetes API requests"},"allowedAudience":{"type":"string","maxLength":1000,"default":"","description":"The optional audience claim that service account JWT tokens must have to authenticate with Infisical"},"hasTokenReviewerJwt":{"type":"boolean","description":"Whether a token reviewer JWT is stored for this template"}},"required":["hasTokenReviewerJwt"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["kubernetes"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"oidcDiscoveryUrl":{"type":"string","description":"The URL used to retrieve the OpenID Connect configuration from the identity provider"},"boundIssuer":{"type":"string","minLength":1,"maxLength":2048,"description":"The unique identifier of the identity provider issuing the JWT"},"boundAudiences":{"type":"string","default":"","description":"The comma-separated list of intended recipients that JWT tokens must have in their aud claim"},"caCert":{"type":"string","maxLength":102400,"description":"The PEM-encoded CA certificate used to validate the identity provider's TLS certificate"}},"required":["oidcDiscoveryUrl","boundIssuer"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["oidc"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"description":"Delete identity auth template","parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"templateId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"description":"Get identity auth template by ID","parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"templateId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"url":{"type":"string","minLength":1},"bindDN":{"type":"string","minLength":1},"searchBase":{"type":"string","minLength":1},"ldapCaCertificate":{"type":"string"},"hasBindPass":{"type":"boolean","description":"Whether a bind password is stored for this template"}},"required":["hasBindPass"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["ldap"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"tokenReviewMode":{"type":"string","enum":["api","gateway"],"default":"api","description":"The mode to use for token review. Must be one of: 'api', 'gateway'"},"kubernetesHost":{"type":"string","minLength":1,"maxLength":255,"nullable":true,"description":"The host string, host:port pair, or URL to the base of the Kubernetes API server"},"caCert":{"type":"string","maxLength":102400,"description":"The PEM-encoded CA certificate used to validate the Kubernetes API server's TLS certificate"},"verifyTlsCertificate":{"type":"boolean","description":"Whether to verify the Kubernetes API server's TLS certificate against the configured CA certificate"},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway to use when performing Kubernetes API requests"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway pool to use when performing Kubernetes API requests"},"allowedAudience":{"type":"string","maxLength":1000,"default":"","description":"The optional audience claim that service account JWT tokens must have to authenticate with Infisical"},"hasTokenReviewerJwt":{"type":"boolean","description":"Whether a token reviewer JWT is stored for this template"}},"required":["hasTokenReviewerJwt"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["kubernetes"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"oidcDiscoveryUrl":{"type":"string","description":"The URL used to retrieve the OpenID Connect configuration from the identity provider"},"boundIssuer":{"type":"string","minLength":1,"maxLength":2048,"description":"The unique identifier of the identity provider issuing the JWT"},"boundAudiences":{"type":"string","default":"","description":"The comma-separated list of intended recipients that JWT tokens must have in their aud claim"},"caCert":{"type":"string","maxLength":102400,"description":"The PEM-encoded CA certificate used to validate the identity provider's TLS certificate"}},"required":["oidcDiscoveryUrl","boundIssuer"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["oidc"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/identity-templates/search":{"get":{"description":"List identity auth templates","parameters":[{"schema":{"type":"number","exclusiveMinimum":true,"minimum":0,"maximum":100,"default":5},"in":"query","name":"limit","required":false},{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"string"},"in":"query","name":"search","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"templates":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"url":{"type":"string","minLength":1},"bindDN":{"type":"string","minLength":1},"searchBase":{"type":"string","minLength":1},"ldapCaCertificate":{"type":"string"},"hasBindPass":{"type":"boolean","description":"Whether a bind password is stored for this template"}},"required":["hasBindPass"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["ldap"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"tokenReviewMode":{"type":"string","enum":["api","gateway"],"default":"api","description":"The mode to use for token review. Must be one of: 'api', 'gateway'"},"kubernetesHost":{"type":"string","minLength":1,"maxLength":255,"nullable":true,"description":"The host string, host:port pair, or URL to the base of the Kubernetes API server"},"caCert":{"type":"string","maxLength":102400,"description":"The PEM-encoded CA certificate used to validate the Kubernetes API server's TLS certificate"},"verifyTlsCertificate":{"type":"boolean","description":"Whether to verify the Kubernetes API server's TLS certificate against the configured CA certificate"},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway to use when performing Kubernetes API requests"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway pool to use when performing Kubernetes API requests"},"allowedAudience":{"type":"string","maxLength":1000,"default":"","description":"The optional audience claim that service account JWT tokens must have to authenticate with Infisical"},"hasTokenReviewerJwt":{"type":"boolean","description":"Whether a token reviewer JWT is stored for this template"}},"required":["hasTokenReviewerJwt"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["kubernetes"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"templateFields":{"type":"object","properties":{"oidcDiscoveryUrl":{"type":"string","description":"The URL used to retrieve the OpenID Connect configuration from the identity provider"},"boundIssuer":{"type":"string","minLength":1,"maxLength":2048,"description":"The unique identifier of the identity provider issuing the JWT"},"boundAudiences":{"type":"string","default":"","description":"The comma-separated list of intended recipients that JWT tokens must have in their aud claim"},"caCert":{"type":"string","maxLength":102400,"description":"The PEM-encoded CA certificate used to validate the identity provider's TLS certificate"}},"required":["oidcDiscoveryUrl","boundIssuer"],"additionalProperties":false},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","enum":["oidc"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","templateFields","orgId","name","authMethod","createdAt","updatedAt"],"additionalProperties":false}]}},"totalCount":{"type":"number"}},"required":["templates","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/identity-templates/{templateId}/usage":{"get":{"description":"Get template usage by template ID","parameters":[{"schema":{"type":"string"},"in":"path","name":"templateId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string"},"identityName":{"type":"string"}},"required":["identityId","identityName"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/identity-templates/{templateId}/delete-usage":{"post":{"description":"Unlink identity auth template usage","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityIds":{"type":"array","items":{"type":"string"}}},"required":["identityIds"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"templateId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"authId":{"type":"string"},"identityId":{"type":"string"},"identityName":{"type":"string"}},"required":["authId","identityId","identityName"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/project-templates":{"get":{"tags":["Project Templates"],"description":"List project templates for the current organization.","parameters":[{"schema":{"type":"string","enum":["secret-manager","cert-manager","kms","secret-scanning","pam","agent-vault"]},"in":"query","name":"type","required":false,"description":"The type of project template to list."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectTemplates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"roles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}}},"required":["name","slug","permissions"],"additionalProperties":false}},"environments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"position":{"type":"number","minimum":1}},"required":["name","slug","position"],"additionalProperties":false},"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","default":"secret-manager"},"projectManagedIdentities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string"}}},"required":["name","roles"],"additionalProperties":false},"nullable":true},"users":{"type":"array","items":{"type":"object","properties":{"username":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string"}}},"required":["username","roles"],"additionalProperties":false},"nullable":true},"groups":{"type":"array","items":{"type":"object","properties":{"groupSlug":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["groupSlug","roles"],"additionalProperties":false},"nullable":true},"identities":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string","format":"uuid"},"identityName":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["identityId","identityName","roles"],"additionalProperties":false},"nullable":true}},"required":["id","name","roles","environments","orgId","createdAt","updatedAt","projectManagedIdentities","users","groups","identities"],"additionalProperties":false}}},"required":["projectTemplates"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["Project Templates"],"description":"Create a project template.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the project template to be created. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"description":"An optional description of the project template."},"roles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"permissions":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"subject":{"type":"string","enum":["secrets"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","describeSecret","readValue","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","describeSecret","readValue","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretTags":{"type":"object","properties":{"$in":{"type":"array","items":{"type":"string","minLength":1}},"$all":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"eventType":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-folders"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-imports"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["dynamic-secrets"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read-root-credential","create-root-credential","edit-root-credential","delete-root-credential","lease"]},{"type":"array","items":{"type":"string","enum":["read-root-credential","create-root-credential","edit-root-credential","delete-root-credential","lease"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"metadata":{"type":"object","properties":{"$elemMatch":{"type":"object","properties":{"key":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"value":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}},"additionalProperties":false}},"required":["$elemMatch"],"additionalProperties":false}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["identity"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges","revoke-auth","edit-auth","create-token","get-token","delete-token"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges","revoke-auth","edit-auth","create-token","get-token","delete-token"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"identityId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"assignableRole":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"assignableSubject":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableAction":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-subscribers"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},"minItems":1}],"description":"Describe what action an entity can take."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$glob":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-templates"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},"minItems":1}],"description":"Describe what action an entity can take."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$glob":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-rotation"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","read-generated-credentials","create","edit","delete","rotate-secrets"]},{"type":"array","items":{"type":"string","enum":["read","read-generated-credentials","create","edit","delete","rotate-secrets"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-syncs"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","sync-secrets","import-secrets","remove-secrets"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","sync-secrets","import-secrets","remove-secrets"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-syncs"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","sync-certificates","import-certificates","remove-certificates","set-post-sync-command","set-health-check-command","set-target-host"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","sync-certificates","import-certificates","remove-certificates","set-post-sync-command","set-health-check-command","set-target-host"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"subscriberName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-event-subscriptions"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["subscribe-to-creation-events","subscribe-to-update-events","subscribe-to-deletion-events","subscribe-to-import-mutation-events"]},{"type":"array","items":{"type":"string","enum":["subscribe-to-creation-events","subscribe-to-update-events","subscribe-to-deletion-events","subscribe-to-import-mutation-events"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-profiles"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-cert","reveal-acme-eab-secret","rotate-acme-eab-secret","manage-application-attachments"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-cert","reveal-acme-eab-secret","rotate-acme-eab-secret","manage-application-attachments"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"slug":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-policies"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$glob":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-application"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","list","create"]},{"type":"array","items":{"type":"string","enum":["read","list","create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-authorities"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-ca-certificate","sign-intermediate"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-ca-certificate","sign-intermediate"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificates"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","read-private-key","import"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","read-private-key","import"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"commonName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"altNames":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"serialNumber":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"friendlyName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"status":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"metadata":{"type":"object","properties":{"$elemMatch":{"type":"object","properties":{"key":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"value":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}},"additionalProperties":false}},"required":["$elemMatch"],"additionalProperties":false}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-certificate-authorities"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-certificates"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-certificate-templates"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-hosts"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-host-groups"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["mcp-endpoints"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["mcp-servers"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["mcp-activity-logs"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-approval"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-rollback"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create"]},{"type":"array","items":{"type":"string","enum":["read","create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["member"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"userEmail":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableRole":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"assignableSubject":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableAction":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["groups"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"groupName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableRole":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["role"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["integrations"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["webhooks"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["service-tokens"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["settings"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-validation-rules"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["environments"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["tags"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["audit-logs"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","edit"]},{"type":"array","items":{"type":"string","enum":["read","edit"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["insights"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","generate-report","delete-report"]},{"type":"array","items":{"type":"string","enum":["read","generate-report","delete-report"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ip-allowlist"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-alerts"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-collections"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-inventory-views"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-discovery"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","run-scan"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","run-scan"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-certificate-installations"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["code-signers"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","sign"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","sign"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["workspace"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["edit","delete"]},{"type":"array","items":{"type":"string","enum":["edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kms"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["edit"]},{"type":"array","items":{"type":"string","enum":["edit"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["cmek"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","encrypt","decrypt","sign","verify","generate-mac","verify-mac","rotate","export-private-key"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","encrypt","decrypt","sign","verify","generate-mac","verify-mac","rotate","export-private-key"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kmip"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create-clients","update-clients","delete-clients","read-clients","generate-client-certificates"]},{"type":"array","items":{"type":"string","enum":["create-clients","update-clients","delete-clients","read-clients","generate-client-certificates"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["commits"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","perform-rollback"]},{"type":"array","items":{"type":"string","enum":["read","perform-rollback"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning-data-sources"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-data-sources","create-data-sources","edit-data-sources","delete-data-sources","trigger-data-source-scans","read-data-source-scans","read-data-source-resources"]},{"type":"array","items":{"type":"string","enum":["read-data-sources","create-data-sources","edit-data-sources","delete-data-sources","trigger-data-source-scans","read-data-source-scans","read-data-source-resources"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning-findings"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-findings","update-findings"]},{"type":"array","items":{"type":"string","enum":["read-findings","update-findings"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning-configs"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-configs","update-configs"]},{"type":"array","items":{"type":"string","enum":["read-configs","update-configs"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["app-connections"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read-app-connections","create-app-connections","edit-app-connections","delete-app-connections","connect-app-connections","rotate-credentials"]},{"type":"array","items":{"type":"string","enum":["read-app-connections","create-app-connections","edit-app-connections","delete-app-connections","connect-app-connections","rotate-credentials"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["hsm-connectors"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-hsm-connectors","create-hsm-connectors","edit-hsm-connectors","delete-hsm-connectors","test-hsm-connectors","attach-hsm-connectors"]},{"type":"array","items":{"type":"string","enum":["read-hsm-connectors","create-hsm-connectors","edit-hsm-connectors","delete-hsm-connectors","test-hsm-connectors","attach-hsm-connectors"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["honey-tokens"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","read-credentials","create","edit","reset","revoke"]},{"type":"array","items":{"type":"string","enum":["read","read-credentials","create","edit","reset","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["proxied-services"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","proxy","report-usage"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","proxy","report-usage"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["agent-vault-access-bundles"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","manage-members"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","manage-members"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["agent-vault-sessions"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","revoke"]},{"type":"array","items":{"type":"string","enum":["read","create","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["agent-vault-proxies"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-token","revoke"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-token","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["approval-requests"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create"]},{"type":"array","items":{"type":"string","enum":["read","create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["approval-request-grants"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","revoke"]},{"type":"array","items":{"type":"string","enum":["read","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-approval-request"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read"]},{"type":"array","items":{"type":"string","enum":["read"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["project-folder-grant"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read-grant","create-grant","revoke-grant"]},{"type":"array","items":{"type":"string","enum":["read-grant","create-grant","revoke-grant"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false}]}}},"required":["name","slug","permissions"],"additionalProperties":false},"default":[],"description":"The roles to be created when the template is applied to a project."},"type":{"type":"string","enum":["secret-manager","cert-manager","kms","secret-scanning","pam","agent-vault"],"description":"The type of project template to be created."},"environments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"position":{"type":"number","minimum":1}},"required":["name","slug","position"],"additionalProperties":false},"nullable":true,"description":"The environments to be created when the template is applied to a project."},"users":{"type":"array","items":{"type":"object","properties":{"username":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"required":["username","roles"],"additionalProperties":false},"default":[],"description":"The users to be automatically added to projects created from this template. Each user is identified by username and assigned one or more roles."},"groups":{"type":"array","items":{"type":"object","properties":{"groupSlug":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"required":["groupSlug","roles"],"additionalProperties":false},"default":[],"description":"The groups to be automatically added to projects created from this template. Each group is identified by slug and assigned one or more roles."},"identities":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string","format":"uuid"},"roles":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"required":["identityId","roles"],"additionalProperties":false},"default":[],"description":"The organization-owned identities to be automatically added to projects created from this template. Each identity is identified by ID and assigned one or more roles."},"projectManagedIdentities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"required":["name","roles"],"additionalProperties":false},"default":[],"description":"The project-owned identities to be automatically created for projects created from this template. Each identity is identified by name and assigned one or more roles."}},"required":["name","type"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectTemplate":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"roles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}}},"required":["name","slug","permissions"],"additionalProperties":false}},"environments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"position":{"type":"number","minimum":1}},"required":["name","slug","position"],"additionalProperties":false},"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","default":"secret-manager"},"projectManagedIdentities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string"}}},"required":["name","roles"],"additionalProperties":false},"nullable":true},"users":{"type":"array","items":{"type":"object","properties":{"username":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string"}}},"required":["username","roles"],"additionalProperties":false},"nullable":true},"groups":{"type":"array","items":{"type":"object","properties":{"groupSlug":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["groupSlug","roles"],"additionalProperties":false},"nullable":true},"identities":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string","format":"uuid"},"identityName":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["identityId","identityName","roles"],"additionalProperties":false},"nullable":true}},"required":["id","name","roles","environments","orgId","createdAt","updatedAt","projectManagedIdentities","users","groups","identities"],"additionalProperties":false}},"required":["projectTemplate"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/project-templates/{templateId}":{"get":{"tags":["Project Templates"],"description":"Get a project template by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"templateId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectTemplate":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"roles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}}},"required":["name","slug","permissions"],"additionalProperties":false}},"environments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"position":{"type":"number","minimum":1}},"required":["name","slug","position"],"additionalProperties":false},"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","default":"secret-manager"},"projectManagedIdentities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string"}}},"required":["name","roles"],"additionalProperties":false},"nullable":true},"users":{"type":"array","items":{"type":"object","properties":{"username":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string"}}},"required":["username","roles"],"additionalProperties":false},"nullable":true},"groups":{"type":"array","items":{"type":"object","properties":{"groupSlug":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["groupSlug","roles"],"additionalProperties":false},"nullable":true},"identities":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string","format":"uuid"},"identityName":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["identityId","identityName","roles"],"additionalProperties":false},"nullable":true}},"required":["id","name","roles","environments","orgId","createdAt","updatedAt","projectManagedIdentities","users","groups","identities"],"additionalProperties":false}},"required":["projectTemplate"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["Project Templates"],"description":"Update a project template.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the project template. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"description":"The updated description of the project template."},"roles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"permissions":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"subject":{"type":"string","enum":["secrets"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","describeSecret","readValue","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","describeSecret","readValue","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretTags":{"type":"object","properties":{"$in":{"type":"array","items":{"type":"string","minLength":1}},"$all":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"eventType":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-folders"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-imports"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["dynamic-secrets"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read-root-credential","create-root-credential","edit-root-credential","delete-root-credential","lease"]},{"type":"array","items":{"type":"string","enum":["read-root-credential","create-root-credential","edit-root-credential","delete-root-credential","lease"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"metadata":{"type":"object","properties":{"$elemMatch":{"type":"object","properties":{"key":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"value":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}},"additionalProperties":false}},"required":["$elemMatch"],"additionalProperties":false}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["identity"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges","revoke-auth","edit-auth","create-token","get-token","delete-token"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges","revoke-auth","edit-auth","create-token","get-token","delete-token"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"identityId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"assignableRole":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"assignableSubject":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableAction":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-subscribers"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},"minItems":1}],"description":"Describe what action an entity can take."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$glob":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-templates"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-cert","list-certs"]},"minItems":1}],"description":"Describe what action an entity can take."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$glob":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-rotation"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","read-generated-credentials","create","edit","delete","rotate-secrets"]},{"type":"array","items":{"type":"string","enum":["read","read-generated-credentials","create","edit","delete","rotate-secrets"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-syncs"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","sync-secrets","import-secrets","remove-secrets"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","sync-secrets","import-secrets","remove-secrets"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-syncs"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","sync-certificates","import-certificates","remove-certificates","set-post-sync-command","set-health-check-command","set-target-host"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","sync-certificates","import-certificates","remove-certificates","set-post-sync-command","set-health-check-command","set-target-host"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"subscriberName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-event-subscriptions"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["subscribe-to-creation-events","subscribe-to-update-events","subscribe-to-deletion-events","subscribe-to-import-mutation-events"]},{"type":"array","items":{"type":"string","enum":["subscribe-to-creation-events","subscribe-to-update-events","subscribe-to-deletion-events","subscribe-to-import-mutation-events"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-profiles"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-cert","reveal-acme-eab-secret","rotate-acme-eab-secret","manage-application-attachments"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-cert","reveal-acme-eab-secret","rotate-acme-eab-secret","manage-application-attachments"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"slug":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-policies"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$glob":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-application"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","list","create"]},{"type":"array","items":{"type":"string","enum":["read","list","create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-authorities"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-ca-certificate","sign-intermediate"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-ca-certificate","sign-intermediate"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificates"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","read-private-key","import"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","read-private-key","import"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"commonName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"altNames":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"serialNumber":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"friendlyName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"status":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"metadata":{"type":"object","properties":{"$elemMatch":{"type":"object","properties":{"key":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false},"value":{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}},"additionalProperties":false}},"required":["$elemMatch"],"additionalProperties":false}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-certificate-authorities"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-certificates"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-certificate-templates"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-hosts"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ssh-host-groups"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["mcp-endpoints"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["mcp-servers"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["mcp-activity-logs"],"description":"DEPRECATED. The entity belonged to a removed product; accepted for backwards compatibility."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","minLength":1,"maxLength":64},{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1}],"description":"DEPRECATED. Accepted for backwards compatibility; grants nothing."},"conditions":{"type":"object","additionalProperties":{},"description":"DEPRECATED. Accepted for backwards compatibility; ignored."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-approval"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-rollback"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create"]},{"type":"array","items":{"type":"string","enum":["read","create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["member"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role","assign-additional-privileges","assume-privileges"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"userEmail":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableRole":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]},"assignableSubject":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableAction":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["groups"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","grant-privileges","assign-role"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"groupName":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"assignableRole":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["role"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["integrations"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["webhooks"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["service-tokens"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["settings"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-validation-rules"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["environments"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["tags"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["audit-logs"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","edit"]},{"type":"array","items":{"type":"string","enum":["read","edit"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["insights"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","generate-report","delete-report"]},{"type":"array","items":{"type":"string","enum":["read","generate-report","delete-report"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["ip-allowlist"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-alerts"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-collections"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["certificate-inventory-views"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-discovery"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","run-scan"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","run-scan"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["pki-certificate-installations"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","edit","delete"]},{"type":"array","items":{"type":"string","enum":["read","edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["code-signers"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","sign"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","sign"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["workspace"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["edit","delete"]},{"type":"array","items":{"type":"string","enum":["edit","delete"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kms"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["edit"]},{"type":"array","items":{"type":"string","enum":["edit"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["cmek"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","encrypt","decrypt","sign","verify","generate-mac","verify-mac","rotate","export-private-key"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","encrypt","decrypt","sign","verify","generate-mac","verify-mac","rotate","export-private-key"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["kmip"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["create-clients","update-clients","delete-clients","read-clients","generate-client-certificates"]},{"type":"array","items":{"type":"string","enum":["create-clients","update-clients","delete-clients","read-clients","generate-client-certificates"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["commits"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","perform-rollback"]},{"type":"array","items":{"type":"string","enum":["read","perform-rollback"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning-data-sources"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-data-sources","create-data-sources","edit-data-sources","delete-data-sources","trigger-data-source-scans","read-data-source-scans","read-data-source-resources"]},{"type":"array","items":{"type":"string","enum":["read-data-sources","create-data-sources","edit-data-sources","delete-data-sources","trigger-data-source-scans","read-data-source-scans","read-data-source-resources"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning-findings"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-findings","update-findings"]},{"type":"array","items":{"type":"string","enum":["read-findings","update-findings"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-scanning-configs"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-configs","update-configs"]},{"type":"array","items":{"type":"string","enum":["read-configs","update-configs"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["app-connections"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read-app-connections","create-app-connections","edit-app-connections","delete-app-connections","connect-app-connections","rotate-credentials"]},{"type":"array","items":{"type":"string","enum":["read-app-connections","create-app-connections","edit-app-connections","delete-app-connections","connect-app-connections","rotate-credentials"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"connectionId":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["hsm-connectors"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read-hsm-connectors","create-hsm-connectors","edit-hsm-connectors","delete-hsm-connectors","test-hsm-connectors","attach-hsm-connectors"]},{"type":"array","items":{"type":"string","enum":["read-hsm-connectors","create-hsm-connectors","edit-hsm-connectors","delete-hsm-connectors","test-hsm-connectors","attach-hsm-connectors"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["honey-tokens"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","read-credentials","create","edit","reset","revoke"]},{"type":"array","items":{"type":"string","enum":["read","read-credentials","create","edit","reset","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["proxied-services"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","proxy","report-usage"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","proxy","report-usage"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["agent-vault-access-bundles"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","manage-members"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","manage-members"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["agent-vault-sessions"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","revoke"]},{"type":"array","items":{"type":"string","enum":["read","create","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["agent-vault-proxies"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read","create","edit","delete","issue-token","revoke"]},{"type":"array","items":{"type":"string","enum":["read","create","edit","delete","issue-token","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["approval-requests"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","create"]},{"type":"array","items":{"type":"string","enum":["read","create"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["approval-request-grants"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read","revoke"]},{"type":"array","items":{"type":"string","enum":["read","revoke"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["secret-approval-request"],"description":"The entity this permission pertains to."},"action":{"anyOf":[{"type":"string","enum":["read"]},{"type":"array","items":{"type":"string","enum":["read"]},"minItems":1}],"description":"Describe what action an entity can take."}},"required":["subject","action"],"additionalProperties":false},{"type":"object","properties":{"subject":{"type":"string","enum":["project-folder-grant"],"description":"The entity this permission pertains to."},"inverted":{"type":"boolean","description":"Whether rule allows or forbids."},"action":{"anyOf":[{"type":"string","enum":["read-grant","create-grant","revoke-grant"]},{"type":"array","items":{"type":"string","enum":["read-grant","create-grant","revoke-grant"]},"minItems":1}],"description":"Describe what action an entity can take."},"conditions":{"type":"object","properties":{"environment":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]},"secretPath":{"anyOf":[{"type":"string"},{"type":"object","properties":{"$eq":{"type":"string","minLength":1},"$ne":{"type":"string","minLength":1},"$in":{"type":"array","items":{"type":"string","minLength":1}},"$glob":{"type":"string","minLength":1}},"additionalProperties":false}]}},"additionalProperties":false,"description":"When specified, only matching conditions will be allowed to access given resource."}},"required":["subject","action"],"additionalProperties":false}]}}},"required":["name","slug","permissions"],"additionalProperties":false},"description":"The updated roles to be created when the template is applied to a project."},"environments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"position":{"type":"number","minimum":1}},"required":["name","slug","position"],"additionalProperties":false},"nullable":true,"description":"The updated environments to be created when the template is applied to a project."},"users":{"type":"array","items":{"type":"object","properties":{"username":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"required":["username","roles"],"additionalProperties":false},"nullable":true,"description":"The updated users to be automatically added to projects created from this template. Each user is identified by username and assigned one or more roles."},"groups":{"type":"array","items":{"type":"object","properties":{"groupSlug":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"required":["groupSlug","roles"],"additionalProperties":false},"nullable":true,"description":"The updated groups to be automatically added to projects created from this template. Each group is identified by slug and assigned one or more roles."},"identities":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string","format":"uuid"},"roles":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"required":["identityId","roles"],"additionalProperties":false},"nullable":true,"description":"The updated organization-owned identities to be automatically added to projects created from this template. Each identity is identified by ID and assigned one or more roles."},"projectManagedIdentities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"required":["name","roles"],"additionalProperties":false},"nullable":true,"description":"The updated project-owned identities to be automatically created for projects created from this template. Each identity is identified by name and assigned one or more roles."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"templateId","required":true,"description":"The ID of the project template to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectTemplate":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"roles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}}},"required":["name","slug","permissions"],"additionalProperties":false}},"environments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"position":{"type":"number","minimum":1}},"required":["name","slug","position"],"additionalProperties":false},"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","default":"secret-manager"},"projectManagedIdentities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string"}}},"required":["name","roles"],"additionalProperties":false},"nullable":true},"users":{"type":"array","items":{"type":"object","properties":{"username":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string"}}},"required":["username","roles"],"additionalProperties":false},"nullable":true},"groups":{"type":"array","items":{"type":"object","properties":{"groupSlug":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["groupSlug","roles"],"additionalProperties":false},"nullable":true},"identities":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string","format":"uuid"},"identityName":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["identityId","identityName","roles"],"additionalProperties":false},"nullable":true}},"required":["id","name","roles","environments","orgId","createdAt","updatedAt","projectManagedIdentities","users","groups","identities"],"additionalProperties":false}},"required":["projectTemplate"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["Project Templates"],"description":"Delete a project template.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"templateId","required":true,"description":"The ID of the project template to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectTemplate":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"roles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"permissions":{"type":"array","items":{"type":"object","properties":{"subject":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"action":{"anyOf":[{"type":"string","minLength":1},{"type":"array","items":{"type":"string"}}]},"conditions":{},"inverted":{"type":"boolean"}},"required":["action"],"additionalProperties":false}}},"required":["name","slug","permissions"],"additionalProperties":false}},"environments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"slug":{"type":"string","minLength":1,"maxLength":64},"position":{"type":"number","minimum":1}},"required":["name","slug","position"],"additionalProperties":false},"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"type":{"type":"string","default":"secret-manager"},"projectManagedIdentities":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string"}}},"required":["name","roles"],"additionalProperties":false},"nullable":true},"users":{"type":"array","items":{"type":"object","properties":{"username":{"type":"string","minLength":1},"roles":{"type":"array","items":{"type":"string"}}},"required":["username","roles"],"additionalProperties":false},"nullable":true},"groups":{"type":"array","items":{"type":"object","properties":{"groupSlug":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["groupSlug","roles"],"additionalProperties":false},"nullable":true},"identities":{"type":"array","items":{"type":"object","properties":{"identityId":{"type":"string","format":"uuid"},"identityName":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}},"required":["identityId","identityName","roles"],"additionalProperties":false},"nullable":true}},"required":["id","name","roles","environments","orgId","createdAt","updatedAt","projectManagedIdentities","users","groups","identities"],"additionalProperties":false}},"required":["projectTemplate"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/access-bundles":{"get":{"operationId":"listAgentVaultAccessBundles","tags":["Agent Vault Access Bundles"],"description":"List the Agent Vault access bundles you can reach","parameters":[{"schema":{"type":"string","enum":["name","serviceCount","createdAt"],"default":"createdAt"},"in":"query","name":"orderBy","required":false,"description":"What to sort access bundles by: name, serviceCount or createdAt."},{"schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"in":"query","name":"orderDirection","required":false,"description":"Which way to sort: asc or desc."},{"schema":{"type":"string","maxLength":255,"pattern":"^[^\\x00-\\x1f\\x7f]*$"},"in":"query","name":"search","required":false,"description":"Match access bundles by name or description."},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false,"description":"The maximum number of access bundles to return."},{"schema":{"type":"integer","minimum":0,"maximum":10000,"default":0},"in":"query","name":"offset","required":false,"description":"How many access bundles to skip."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessBundles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"serviceCount":{"type":"number","description":"How many services the access bundle holds."},"memberCount":{"type":"number","description":"How many users, machine identities and groups can reach the access bundle."},"hostPatterns":{"type":"array","items":{"type":"string"},"description":"Every host pattern the access bundle's services cover."}},"required":["id","name","createdAt","updatedAt","serviceCount","memberCount","hostPatterns"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["accessBundles","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAgentVaultAccessBundle","tags":["Agent Vault Access Bundles"],"description":"Create an Agent Vault access bundle","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the access bundle."},"description":{"type":"string","maxLength":256,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"A description of what this access bundle is for."}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessBundle":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"required":["accessBundle"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/access-bundles/{accessBundleId}":{"get":{"operationId":"getAgentVaultAccessBundle","tags":["Agent Vault Access Bundles"],"description":"Get an Agent Vault access bundle with its services","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessBundle":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"services":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the service."},"accessBundleId":{"type":"string","format":"uuid","description":"The ID of the access bundle."},"name":{"type":"string","description":"The name of the service."},"hostPattern":{"type":"string","description":"A comma-separated set of hosts this service covers, each optionally with a port (defaults to `443`). A leading `*.` wildcard matches exactly one label. Paths are not supported."},"allowedMethods":{"type":"array","items":{"type":"string","enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS"]},"nullable":true,"description":"The HTTP methods this service allows. Null allows every method. Anything else is refused by the proxy with a 403."},"allowedPathPrefixes":{"type":"array","items":{"type":"string"},"nullable":true,"description":"The path prefixes this service allows, matched on whole segments, so `/repos` covers `/repos/octo` but not `/repositories`. `null` allows every path. A path-restricted service also refuses any request whose path would have to be normalised to judge."},"credential":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["bearer"]},"headerName":{"type":"string","description":"The header the credential is written to. Defaults to `Authorization`."},"headerPrefix":{"type":"string","description":"Written before the credential value, separated by one space. Leave empty for a header that carries the value alone, such as DD-API-KEY. Can't contain `{{` or `}}`. On update a field left out keeps its stored value, so send an empty string to clear the prefix when changing the header."}},"required":["type","headerName","headerPrefix"],"additionalProperties":false,"title":"Bearer"},{"type":"object","properties":{"type":{"type":"string","enum":["basic"]}},"required":["type"],"additionalProperties":false,"title":"Basic Auth"},{"type":"object","properties":{"type":{"type":"string","enum":["passthrough"]}},"required":["type"],"additionalProperties":false,"title":"Pass-through"}]},"customHeaders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the custom header. Send it to change that header in place. Omit it to match by name."},"name":{"type":"string","description":"The name of the header, which must not be the credential's own header."},"prefix":{"type":"string","description":"Written before the header value, separated by one space. Leave empty to send the value alone. Can't contain `{{` or `}}`."}},"required":["id","name","prefix"],"additionalProperties":false},"description":"Additional headers the proxy attaches to every request to this service, on top of the credential. Send the full list. A header you leave out is deleted. Send a header's `id` to change it in place and keep its stored value. Without an `id`, a header is matched by name."},"substitutions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the substitution. Send it to change that substitution in place. Omit it to match by placeholder."},"placeholder":{"type":"string","description":"The fake value your agent already sends. The proxy replaces it with the real secret. Matched as a plain string, so a distinctive placeholder is worth choosing. Can't contain `{{` or `}}`."},"surfaces":{"type":"array","items":{"type":"string","enum":["path","query","header","body"]},"description":"Where in the request to look for the placeholder: path, query, header or body."}},"required":["id","placeholder","surfaces"],"additionalProperties":false},"description":"Placeholders the proxy swaps for a real secret before forwarding. Send the full list. A substitution you leave out is deleted. Send a substitution's `id` to change it in place and keep its stored value. Without an `id`, it is matched by its placeholder."},"variableReferences":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"variableId":{"type":"string","format":"uuid","description":"The ID of the variable."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"field":{"type":"string","enum":["credential-value","credential-username"],"description":"Which value uses the variable: credential-value (a bearer token or a basic password), credential-username, custom-header or substitution."}},"required":["variableId","key","field"],"additionalProperties":false,"title":"Credential"},{"type":"object","properties":{"variableId":{"type":"string","format":"uuid","description":"The ID of the variable."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"field":{"type":"string","enum":["custom-header"],"description":"Which value uses the variable: credential-value (a bearer token or a basic password), credential-username, custom-header or substitution."},"customHeaderId":{"type":"string","format":"uuid","description":"The custom header whose value uses the variable."}},"required":["variableId","key","field","customHeaderId"],"additionalProperties":false,"title":"Custom Header"},{"type":"object","properties":{"variableId":{"type":"string","format":"uuid","description":"The ID of the variable."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"field":{"type":"string","enum":["substitution"],"description":"Which value uses the variable: credential-value (a bearer token or a basic password), credential-username, custom-header or substitution."},"substitutionId":{"type":"string","format":"uuid","description":"The substitution whose value uses the variable."}},"required":["variableId","key","field","substitutionId"],"additionalProperties":false,"title":"Substitution"}]},"description":"The variables this service's credential, custom header values and substitution values use. Not returned to Agent Vault members, since only admins can see variables."},"createdAt":{"type":"string","format":"date-time","description":"When the service was added to the access bundle."},"updatedAt":{"type":"string","format":"date-time","description":"When the service was last changed."}},"required":["id","accessBundleId","name","hostPattern","allowedMethods","allowedPathPrefixes","credential","customHeaders","substitutions","createdAt","updatedAt"],"additionalProperties":false}}},"required":["id","name","createdAt","updatedAt","services"],"additionalProperties":false}},"required":["accessBundle"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAgentVaultAccessBundle","tags":["Agent Vault Access Bundles"],"description":"Update an Agent Vault access bundle","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the access bundle."},"description":{"type":"string","maxLength":256,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"A description of what this access bundle is for.","nullable":true}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessBundle":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"required":["accessBundle"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAgentVaultAccessBundle","tags":["Agent Vault Access Bundles"],"description":"Delete an Agent Vault access bundle","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessBundle":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"required":["accessBundle"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/access-bundles/{accessBundleId}/services":{"post":{"operationId":"createAgentVaultService","tags":["Agent Vault Access Bundles"],"description":"Create a service in an Agent Vault access bundle","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the service."},"hostPattern":{"type":"string","maxLength":1024,"description":"A comma-separated set of hosts this service covers, each optionally with a port (defaults to `443`). A leading `*.` wildcard matches exactly one label. Paths are not supported."},"allowedMethods":{"type":"array","items":{"type":"string","enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS"]},"minItems":1,"maxItems":7,"nullable":true,"description":"The HTTP methods this service allows. Null allows every method. Anything else is refused by the proxy with a 403."},"allowedPathPrefixes":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":20,"nullable":true,"description":"The path prefixes this service allows, matched on whole segments, so `/repos` covers `/repos/octo` but not `/repositories`. `null` allows every path. A path-restricted service also refuses any request whose path would have to be normalised to judge."},"credential":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["bearer"]},"headerName":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9!#$%&'*+.^_`|~-]+$","description":"The header the credential is written to. Defaults to `Authorization`."},"headerPrefix":{"type":"string","maxLength":64,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"Written before the credential value, separated by one space. Leave empty for a header that carries the value alone, such as DD-API-KEY. Can't contain `{{` or `}}`. On update a field left out keeps its stored value, so send an empty string to clear the prefix when changing the header."},"value":{"type":"string","minLength":1,"maxLength":8192,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The secret. Can use up to 3 references to the access bundle's variables, written as `{{KEY}}`. A reference that repeats counts each time. Never returned once saved."}},"required":["type","value"],"additionalProperties":false,"title":"Bearer"},{"type":"object","properties":{"type":{"type":"string","enum":["basic"]},"username":{"type":"string","maxLength":256,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The username half of the basic credential. May be empty if a password is set. Can use up to 3 references to the access bundle's variables, written as `{{KEY}}`. A reference that repeats counts each time. Never returned once saved, since some APIs put the whole key here."},"password":{"type":"string","maxLength":8192,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The password half of the basic credential. May be empty if a username is set, for APIs that carry the whole key in the username. Can use up to 3 references to the access bundle's variables, written as `{{KEY}}`. A reference that repeats counts each time. Never returned once saved."}},"required":["type","username","password"],"additionalProperties":false,"title":"Basic Auth"},{"type":"object","properties":{"type":{"type":"string","enum":["passthrough"]}},"required":["type"],"additionalProperties":false,"title":"Pass-through"}]},"customHeaders":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9!#$%&'*+.^_`|~-]+$","description":"The name of the header, which must not be the credential's own header."},"prefix":{"type":"string","maxLength":64,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"Written before the header value, separated by one space. Leave empty to send the value alone. Can't contain `{{` or `}}`."},"value":{"type":"string","minLength":1,"maxLength":8192,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The header value. Can use up to 3 references to the access bundle's variables, written as `{{KEY}}`. A reference that repeats counts each time. Never returned once saved."}},"required":["name","value"],"additionalProperties":false},"maxItems":20,"description":"Additional headers the proxy attaches to every request to this service, on top of the credential. Send the full list. A header you leave out is deleted. Send a header's `id` to change it in place and keep its stored value. Without an `id`, a header is matched by name."},"substitutions":{"type":"array","items":{"type":"object","properties":{"placeholder":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The fake value your agent already sends. The proxy replaces it with the real secret. Matched as a plain string, so a distinctive placeholder is worth choosing. Can't contain `{{` or `}}`."},"surfaces":{"type":"array","items":{"type":"string","enum":["path","query","header","body"]},"minItems":1,"maxItems":4,"description":"Where in the request to look for the placeholder: path, query, header or body."},"value":{"type":"string","minLength":1,"maxLength":8192,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The real value the placeholder is replaced with. Can use up to 3 references to the access bundle's variables, written as `{{KEY}}`. A reference that repeats counts each time. Never returned once saved."}},"required":["placeholder","surfaces","value"],"additionalProperties":false},"maxItems":20,"description":"Placeholders the proxy swaps for a real secret before forwarding. Send the full list. A substitution you leave out is deleted. Send a substitution's `id` to change it in place and keep its stored value. Without an `id`, it is matched by its placeholder."}},"required":["name","hostPattern","credential"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the service."},"accessBundleId":{"type":"string","format":"uuid","description":"The ID of the access bundle."},"name":{"type":"string","description":"The name of the service."},"hostPattern":{"type":"string","description":"A comma-separated set of hosts this service covers, each optionally with a port (defaults to `443`). A leading `*.` wildcard matches exactly one label. Paths are not supported."},"allowedMethods":{"type":"array","items":{"type":"string","enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS"]},"nullable":true,"description":"The HTTP methods this service allows. Null allows every method. Anything else is refused by the proxy with a 403."},"allowedPathPrefixes":{"type":"array","items":{"type":"string"},"nullable":true,"description":"The path prefixes this service allows, matched on whole segments, so `/repos` covers `/repos/octo` but not `/repositories`. `null` allows every path. A path-restricted service also refuses any request whose path would have to be normalised to judge."},"credential":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["bearer"]},"headerName":{"type":"string","description":"The header the credential is written to. Defaults to `Authorization`."},"headerPrefix":{"type":"string","description":"Written before the credential value, separated by one space. Leave empty for a header that carries the value alone, such as DD-API-KEY. Can't contain `{{` or `}}`. On update a field left out keeps its stored value, so send an empty string to clear the prefix when changing the header."}},"required":["type","headerName","headerPrefix"],"additionalProperties":false,"title":"Bearer"},{"type":"object","properties":{"type":{"type":"string","enum":["basic"]}},"required":["type"],"additionalProperties":false,"title":"Basic Auth"},{"type":"object","properties":{"type":{"type":"string","enum":["passthrough"]}},"required":["type"],"additionalProperties":false,"title":"Pass-through"}]},"customHeaders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the custom header. Send it to change that header in place. Omit it to match by name."},"name":{"type":"string","description":"The name of the header, which must not be the credential's own header."},"prefix":{"type":"string","description":"Written before the header value, separated by one space. Leave empty to send the value alone. Can't contain `{{` or `}}`."}},"required":["id","name","prefix"],"additionalProperties":false},"description":"Additional headers the proxy attaches to every request to this service, on top of the credential. Send the full list. A header you leave out is deleted. Send a header's `id` to change it in place and keep its stored value. Without an `id`, a header is matched by name."},"substitutions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the substitution. Send it to change that substitution in place. Omit it to match by placeholder."},"placeholder":{"type":"string","description":"The fake value your agent already sends. The proxy replaces it with the real secret. Matched as a plain string, so a distinctive placeholder is worth choosing. Can't contain `{{` or `}}`."},"surfaces":{"type":"array","items":{"type":"string","enum":["path","query","header","body"]},"description":"Where in the request to look for the placeholder: path, query, header or body."}},"required":["id","placeholder","surfaces"],"additionalProperties":false},"description":"Placeholders the proxy swaps for a real secret before forwarding. Send the full list. A substitution you leave out is deleted. Send a substitution's `id` to change it in place and keep its stored value. Without an `id`, it is matched by its placeholder."},"variableReferences":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"variableId":{"type":"string","format":"uuid","description":"The ID of the variable."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"field":{"type":"string","enum":["credential-value","credential-username"],"description":"Which value uses the variable: credential-value (a bearer token or a basic password), credential-username, custom-header or substitution."}},"required":["variableId","key","field"],"additionalProperties":false,"title":"Credential"},{"type":"object","properties":{"variableId":{"type":"string","format":"uuid","description":"The ID of the variable."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"field":{"type":"string","enum":["custom-header"],"description":"Which value uses the variable: credential-value (a bearer token or a basic password), credential-username, custom-header or substitution."},"customHeaderId":{"type":"string","format":"uuid","description":"The custom header whose value uses the variable."}},"required":["variableId","key","field","customHeaderId"],"additionalProperties":false,"title":"Custom Header"},{"type":"object","properties":{"variableId":{"type":"string","format":"uuid","description":"The ID of the variable."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"field":{"type":"string","enum":["substitution"],"description":"Which value uses the variable: credential-value (a bearer token or a basic password), credential-username, custom-header or substitution."},"substitutionId":{"type":"string","format":"uuid","description":"The substitution whose value uses the variable."}},"required":["variableId","key","field","substitutionId"],"additionalProperties":false,"title":"Substitution"}]},"description":"The variables this service's credential, custom header values and substitution values use. Not returned to Agent Vault members, since only admins can see variables."},"createdAt":{"type":"string","format":"date-time","description":"When the service was added to the access bundle."},"updatedAt":{"type":"string","format":"date-time","description":"When the service was last changed."}},"required":["id","accessBundleId","name","hostPattern","allowedMethods","allowedPathPrefixes","credential","customHeaders","substitutions","variableReferences","createdAt","updatedAt"],"additionalProperties":false}},"required":["service"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/access-bundles/{accessBundleId}/services/{serviceId}":{"patch":{"operationId":"updateAgentVaultService","tags":["Agent Vault Access Bundles"],"description":"Update a service in an Agent Vault access bundle","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the service."},"hostPattern":{"type":"string","maxLength":1024,"description":"A comma-separated set of hosts this service covers, each optionally with a port (defaults to `443`). A leading `*.` wildcard matches exactly one label. Paths are not supported."},"allowedMethods":{"type":"array","items":{"type":"string","enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS"]},"minItems":1,"maxItems":7,"nullable":true,"description":"The HTTP methods this service allows. Null allows every method. Anything else is refused by the proxy with a 403."},"allowedPathPrefixes":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":20,"nullable":true,"description":"The path prefixes this service allows, matched on whole segments, so `/repos` covers `/repos/octo` but not `/repositories`. `null` allows every path. A path-restricted service also refuses any request whose path would have to be normalised to judge."},"credential":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["bearer"]},"headerName":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9!#$%&'*+.^_`|~-]+$","description":"The header the credential is written to. Defaults to `Authorization`."},"headerPrefix":{"type":"string","maxLength":64,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"Written before the credential value, separated by one space. Leave empty for a header that carries the value alone, such as DD-API-KEY. Can't contain `{{` or `}}`. On update a field left out keeps its stored value, so send an empty string to clear the prefix when changing the header."},"value":{"type":"string","minLength":1,"maxLength":8192,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The secret. Can use up to 3 references to the access bundle's variables, written as `{{KEY}}`. A reference that repeats counts each time. Omit to keep the stored secret."}},"required":["type"],"additionalProperties":false,"title":"Bearer"},{"type":"object","properties":{"type":{"type":"string","enum":["basic"]},"username":{"type":"string","maxLength":256,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The username half of the basic credential. Can use up to 3 references to the access bundle's variables, written as `{{KEY}}`. A reference that repeats counts each time. Omit to keep the stored username; send an empty string to remove it, which requires a password."},"password":{"type":"string","maxLength":8192,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The password half of the basic credential. Can use up to 3 references to the access bundle's variables, written as `{{KEY}}`. A reference that repeats counts each time. Omit to keep the stored password; send an empty string to remove it, which requires a username."}},"required":["type"],"additionalProperties":false,"title":"Basic Auth"},{"type":"object","properties":{"type":{"type":"string","enum":["passthrough"]}},"required":["type"],"additionalProperties":false,"title":"Pass-through"}]},"customHeaders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the custom header. Send it to change that header in place. Omit it to match by name."},"name":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9!#$%&'*+.^_`|~-]+$","description":"The name of the header, which must not be the credential's own header."},"prefix":{"type":"string","maxLength":64,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"Written before the header value, separated by one space. Can't contain `{{` or `}}`. Unlike the value, an omitted prefix is cleared rather than kept, since the stored prefix is returned and can be resent."},"value":{"type":"string","minLength":1,"maxLength":8192,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The header value. Can use up to 3 references to the access bundle's variables, written as `{{KEY}}`. A reference that repeats counts each time. Omit to keep the value already stored for this header."}},"required":["name"],"additionalProperties":false},"maxItems":20,"description":"Additional headers the proxy attaches to every request to this service, on top of the credential. Send the full list. A header you leave out is deleted. Send a header's `id` to change it in place and keep its stored value. Without an `id`, a header is matched by name."},"substitutions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the substitution. Send it to change that substitution in place. Omit it to match by placeholder."},"placeholder":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The fake value your agent already sends. The proxy replaces it with the real secret. Matched as a plain string, so a distinctive placeholder is worth choosing. Can't contain `{{` or `}}`."},"surfaces":{"type":"array","items":{"type":"string","enum":["path","query","header","body"]},"minItems":1,"maxItems":4,"description":"Where in the request to look for the placeholder: path, query, header or body."},"value":{"type":"string","minLength":1,"maxLength":8192,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The real value the placeholder is replaced with. Can use up to 3 references to the access bundle's variables, written as `{{KEY}}`. A reference that repeats counts each time. Omit to keep the value already stored."}},"required":["placeholder","surfaces"],"additionalProperties":false},"maxItems":20,"description":"Placeholders the proxy swaps for a real secret before forwarding. Send the full list. A substitution you leave out is deleted. Send a substitution's `id` to change it in place and keep its stored value. Without an `id`, it is matched by its placeholder."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"serviceId","required":true,"description":"The ID of the service."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the service."},"accessBundleId":{"type":"string","format":"uuid","description":"The ID of the access bundle."},"name":{"type":"string","description":"The name of the service."},"hostPattern":{"type":"string","description":"A comma-separated set of hosts this service covers, each optionally with a port (defaults to `443`). A leading `*.` wildcard matches exactly one label. Paths are not supported."},"allowedMethods":{"type":"array","items":{"type":"string","enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS"]},"nullable":true,"description":"The HTTP methods this service allows. Null allows every method. Anything else is refused by the proxy with a 403."},"allowedPathPrefixes":{"type":"array","items":{"type":"string"},"nullable":true,"description":"The path prefixes this service allows, matched on whole segments, so `/repos` covers `/repos/octo` but not `/repositories`. `null` allows every path. A path-restricted service also refuses any request whose path would have to be normalised to judge."},"credential":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["bearer"]},"headerName":{"type":"string","description":"The header the credential is written to. Defaults to `Authorization`."},"headerPrefix":{"type":"string","description":"Written before the credential value, separated by one space. Leave empty for a header that carries the value alone, such as DD-API-KEY. Can't contain `{{` or `}}`. On update a field left out keeps its stored value, so send an empty string to clear the prefix when changing the header."}},"required":["type","headerName","headerPrefix"],"additionalProperties":false,"title":"Bearer"},{"type":"object","properties":{"type":{"type":"string","enum":["basic"]}},"required":["type"],"additionalProperties":false,"title":"Basic Auth"},{"type":"object","properties":{"type":{"type":"string","enum":["passthrough"]}},"required":["type"],"additionalProperties":false,"title":"Pass-through"}]},"customHeaders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the custom header. Send it to change that header in place. Omit it to match by name."},"name":{"type":"string","description":"The name of the header, which must not be the credential's own header."},"prefix":{"type":"string","description":"Written before the header value, separated by one space. Leave empty to send the value alone. Can't contain `{{` or `}}`."}},"required":["id","name","prefix"],"additionalProperties":false},"description":"Additional headers the proxy attaches to every request to this service, on top of the credential. Send the full list. A header you leave out is deleted. Send a header's `id` to change it in place and keep its stored value. Without an `id`, a header is matched by name."},"substitutions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the substitution. Send it to change that substitution in place. Omit it to match by placeholder."},"placeholder":{"type":"string","description":"The fake value your agent already sends. The proxy replaces it with the real secret. Matched as a plain string, so a distinctive placeholder is worth choosing. Can't contain `{{` or `}}`."},"surfaces":{"type":"array","items":{"type":"string","enum":["path","query","header","body"]},"description":"Where in the request to look for the placeholder: path, query, header or body."}},"required":["id","placeholder","surfaces"],"additionalProperties":false},"description":"Placeholders the proxy swaps for a real secret before forwarding. Send the full list. A substitution you leave out is deleted. Send a substitution's `id` to change it in place and keep its stored value. Without an `id`, it is matched by its placeholder."},"variableReferences":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"variableId":{"type":"string","format":"uuid","description":"The ID of the variable."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"field":{"type":"string","enum":["credential-value","credential-username"],"description":"Which value uses the variable: credential-value (a bearer token or a basic password), credential-username, custom-header or substitution."}},"required":["variableId","key","field"],"additionalProperties":false,"title":"Credential"},{"type":"object","properties":{"variableId":{"type":"string","format":"uuid","description":"The ID of the variable."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"field":{"type":"string","enum":["custom-header"],"description":"Which value uses the variable: credential-value (a bearer token or a basic password), credential-username, custom-header or substitution."},"customHeaderId":{"type":"string","format":"uuid","description":"The custom header whose value uses the variable."}},"required":["variableId","key","field","customHeaderId"],"additionalProperties":false,"title":"Custom Header"},{"type":"object","properties":{"variableId":{"type":"string","format":"uuid","description":"The ID of the variable."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"field":{"type":"string","enum":["substitution"],"description":"Which value uses the variable: credential-value (a bearer token or a basic password), credential-username, custom-header or substitution."},"substitutionId":{"type":"string","format":"uuid","description":"The substitution whose value uses the variable."}},"required":["variableId","key","field","substitutionId"],"additionalProperties":false,"title":"Substitution"}]},"description":"The variables this service's credential, custom header values and substitution values use. Not returned to Agent Vault members, since only admins can see variables."},"createdAt":{"type":"string","format":"date-time","description":"When the service was added to the access bundle."},"updatedAt":{"type":"string","format":"date-time","description":"When the service was last changed."}},"required":["id","accessBundleId","name","hostPattern","allowedMethods","allowedPathPrefixes","credential","customHeaders","substitutions","variableReferences","createdAt","updatedAt"],"additionalProperties":false}},"required":["service"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAgentVaultService","tags":["Agent Vault Access Bundles"],"description":"Delete a service from an Agent Vault access bundle","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"serviceId","required":true,"description":"The ID of the service."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"service":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the service."},"accessBundleId":{"type":"string","format":"uuid","description":"The ID of the access bundle."},"name":{"type":"string","description":"The name of the service."},"hostPattern":{"type":"string","description":"A comma-separated set of hosts this service covers, each optionally with a port (defaults to `443`). A leading `*.` wildcard matches exactly one label. Paths are not supported."},"allowedMethods":{"type":"array","items":{"type":"string","enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS"]},"nullable":true,"description":"The HTTP methods this service allows. Null allows every method. Anything else is refused by the proxy with a 403."},"allowedPathPrefixes":{"type":"array","items":{"type":"string"},"nullable":true,"description":"The path prefixes this service allows, matched on whole segments, so `/repos` covers `/repos/octo` but not `/repositories`. `null` allows every path. A path-restricted service also refuses any request whose path would have to be normalised to judge."},"credential":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["bearer"]},"headerName":{"type":"string","description":"The header the credential is written to. Defaults to `Authorization`."},"headerPrefix":{"type":"string","description":"Written before the credential value, separated by one space. Leave empty for a header that carries the value alone, such as DD-API-KEY. Can't contain `{{` or `}}`. On update a field left out keeps its stored value, so send an empty string to clear the prefix when changing the header."}},"required":["type","headerName","headerPrefix"],"additionalProperties":false,"title":"Bearer"},{"type":"object","properties":{"type":{"type":"string","enum":["basic"]}},"required":["type"],"additionalProperties":false,"title":"Basic Auth"},{"type":"object","properties":{"type":{"type":"string","enum":["passthrough"]}},"required":["type"],"additionalProperties":false,"title":"Pass-through"}]},"customHeaders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the custom header. Send it to change that header in place. Omit it to match by name."},"name":{"type":"string","description":"The name of the header, which must not be the credential's own header."},"prefix":{"type":"string","description":"Written before the header value, separated by one space. Leave empty to send the value alone. Can't contain `{{` or `}}`."}},"required":["id","name","prefix"],"additionalProperties":false},"description":"Additional headers the proxy attaches to every request to this service, on top of the credential. Send the full list. A header you leave out is deleted. Send a header's `id` to change it in place and keep its stored value. Without an `id`, a header is matched by name."},"substitutions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the substitution. Send it to change that substitution in place. Omit it to match by placeholder."},"placeholder":{"type":"string","description":"The fake value your agent already sends. The proxy replaces it with the real secret. Matched as a plain string, so a distinctive placeholder is worth choosing. Can't contain `{{` or `}}`."},"surfaces":{"type":"array","items":{"type":"string","enum":["path","query","header","body"]},"description":"Where in the request to look for the placeholder: path, query, header or body."}},"required":["id","placeholder","surfaces"],"additionalProperties":false},"description":"Placeholders the proxy swaps for a real secret before forwarding. Send the full list. A substitution you leave out is deleted. Send a substitution's `id` to change it in place and keep its stored value. Without an `id`, it is matched by its placeholder."},"variableReferences":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"variableId":{"type":"string","format":"uuid","description":"The ID of the variable."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"field":{"type":"string","enum":["credential-value","credential-username"],"description":"Which value uses the variable: credential-value (a bearer token or a basic password), credential-username, custom-header or substitution."}},"required":["variableId","key","field"],"additionalProperties":false,"title":"Credential"},{"type":"object","properties":{"variableId":{"type":"string","format":"uuid","description":"The ID of the variable."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"field":{"type":"string","enum":["custom-header"],"description":"Which value uses the variable: credential-value (a bearer token or a basic password), credential-username, custom-header or substitution."},"customHeaderId":{"type":"string","format":"uuid","description":"The custom header whose value uses the variable."}},"required":["variableId","key","field","customHeaderId"],"additionalProperties":false,"title":"Custom Header"},{"type":"object","properties":{"variableId":{"type":"string","format":"uuid","description":"The ID of the variable."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"field":{"type":"string","enum":["substitution"],"description":"Which value uses the variable: credential-value (a bearer token or a basic password), credential-username, custom-header or substitution."},"substitutionId":{"type":"string","format":"uuid","description":"The substitution whose value uses the variable."}},"required":["variableId","key","field","substitutionId"],"additionalProperties":false,"title":"Substitution"}]},"description":"The variables this service's credential, custom header values and substitution values use. Not returned to Agent Vault members, since only admins can see variables."},"createdAt":{"type":"string","format":"date-time","description":"When the service was added to the access bundle."},"updatedAt":{"type":"string","format":"date-time","description":"When the service was last changed."}},"required":["id","accessBundleId","name","hostPattern","allowedMethods","allowedPathPrefixes","credential","customHeaders","substitutions","variableReferences","createdAt","updatedAt"],"additionalProperties":false}},"required":["service"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/access-bundles/{accessBundleId}/variables":{"get":{"operationId":"listAgentVaultVariables","tags":["Agent Vault Access Bundles"],"description":"List the variables in an Agent Vault access bundle","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"variables":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the variable."},"accessBundleId":{"type":"string","format":"uuid","description":"The ID of the access bundle."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"isSecret":{"type":"boolean","description":"Whether the value is hidden once saved. A secret value is only returned by the value endpoint."},"value":{"type":"string","nullable":true,"description":"The value, for a variable that is not secret. Null for a secret one: read it from the value endpoint."},"serviceIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The IDs of the services in the access bundle that use this variable. A variable in use can't be deleted."},"createdAt":{"type":"string","format":"date-time","description":"When the variable was added to the access bundle."},"updatedAt":{"type":"string","format":"date-time","description":"When the variable was last changed."}},"required":["id","accessBundleId","key","isSecret","value","serviceIds","createdAt","updatedAt"],"additionalProperties":false}}},"required":["variables"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAgentVaultVariable","tags":["Agent Vault Access Bundles"],"description":"Create a variable in an Agent Vault access bundle","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Z][A-Z0-9_]*$","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"value":{"type":"string","minLength":1,"maxLength":8192,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The value the proxy puts in place of each `{{KEY}}`."},"isSecret":{"type":"boolean","default":true,"description":"Whether the value is hidden once saved. A secret value is only returned by the value endpoint."}},"required":["key","value"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"variable":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the variable."},"accessBundleId":{"type":"string","format":"uuid","description":"The ID of the access bundle."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"isSecret":{"type":"boolean","description":"Whether the value is hidden once saved. A secret value is only returned by the value endpoint."},"value":{"type":"string","nullable":true,"description":"The value, for a variable that is not secret. Null for a secret one: read it from the value endpoint."},"serviceIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The IDs of the services in the access bundle that use this variable. A variable in use can't be deleted."},"createdAt":{"type":"string","format":"date-time","description":"When the variable was added to the access bundle."},"updatedAt":{"type":"string","format":"date-time","description":"When the variable was last changed."}},"required":["id","accessBundleId","key","isSecret","value","serviceIds","createdAt","updatedAt"],"additionalProperties":false}},"required":["variable"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/access-bundles/{accessBundleId}/variables/{variableId}":{"patch":{"operationId":"updateAgentVaultVariable","tags":["Agent Vault Access Bundles"],"description":"Update a variable in an Agent Vault access bundle","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Z][A-Z0-9_]*$","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"value":{"type":"string","minLength":1,"maxLength":8192,"pattern":"^[^\\x00-\\x1f\\x7f]*$","description":"The value the proxy puts in place of each `{{KEY}}`. Omit to keep the stored value."},"isSecret":{"type":"boolean","description":"Whether the value is hidden once saved. A secret value is only returned by the value endpoint."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"variableId","required":true,"description":"The ID of the variable."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"variable":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the variable."},"accessBundleId":{"type":"string","format":"uuid","description":"The ID of the access bundle."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"isSecret":{"type":"boolean","description":"Whether the value is hidden once saved. A secret value is only returned by the value endpoint."},"value":{"type":"string","nullable":true,"description":"The value, for a variable that is not secret. Null for a secret one: read it from the value endpoint."},"serviceIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The IDs of the services in the access bundle that use this variable. A variable in use can't be deleted."},"createdAt":{"type":"string","format":"date-time","description":"When the variable was added to the access bundle."},"updatedAt":{"type":"string","format":"date-time","description":"When the variable was last changed."}},"required":["id","accessBundleId","key","isSecret","value","serviceIds","createdAt","updatedAt"],"additionalProperties":false}},"required":["variable"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAgentVaultVariable","tags":["Agent Vault Access Bundles"],"description":"Delete a variable from an Agent Vault access bundle. A variable a service uses can't be deleted.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"variableId","required":true,"description":"The ID of the variable."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"variable":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the variable."},"accessBundleId":{"type":"string","format":"uuid","description":"The ID of the access bundle."},"key":{"type":"string","description":"The name services use to refer to the variable, as `{{KEY}}`. Starts with a letter and uses only upper case letters, numbers and underscores."},"isSecret":{"type":"boolean","description":"Whether the value is hidden once saved. A secret value is only returned by the value endpoint."},"value":{"type":"string","nullable":true,"description":"The value, for a variable that is not secret. Null for a secret one: read it from the value endpoint."},"serviceIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The IDs of the services in the access bundle that use this variable. A variable in use can't be deleted."},"createdAt":{"type":"string","format":"date-time","description":"When the variable was added to the access bundle."},"updatedAt":{"type":"string","format":"date-time","description":"When the variable was last changed."}},"required":["id","accessBundleId","key","isSecret","value","serviceIds","createdAt","updatedAt"],"additionalProperties":false}},"required":["variable"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/access-bundles/{accessBundleId}/variables/{variableId}/value":{"get":{"operationId":"getAgentVaultVariableValue","tags":["Agent Vault Access Bundles"],"description":"Get the value of a variable in an Agent Vault access bundle, secret or not","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"variableId","required":true,"description":"The ID of the variable."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"value":{"type":"string","description":"The variable's value."}},"required":["value"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/access-bundles/{accessBundleId}/members":{"get":{"operationId":"listAgentVaultAccessBundleMembers","tags":["Agent Vault Access Bundles"],"description":"List who can reach an Agent Vault access bundle","parameters":[{"schema":{"type":"string","maxLength":255,"pattern":"^[^\\x00-\\x1f\\x7f]*$"},"in":"query","name":"search","required":false,"description":"Match members by name, username or email address."},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false,"description":"The maximum number of members to return."},{"schema":{"type":"integer","minimum":0,"maximum":10000,"default":0},"in":"query","name":"offset","required":false,"description":"How many members to skip."},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the access bundle membership."},"createdAt":{"type":"string","format":"date-time","description":"When the access bundle was granted."},"actor":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"username":{"type":"string","description":"The username of the user."},"email":{"type":"string","nullable":true,"description":"The email address of the user."},"firstName":{"type":"string","nullable":true,"description":"The first name of the user."},"lastName":{"type":"string","nullable":true,"description":"The last name of the user."}},"required":["type","id","username","email","firstName","lastName"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"name":{"type":"string","description":"The name of the machine identity."}},"required":["type","id","name"],"additionalProperties":false,"title":"Machine identity"},{"type":"object","properties":{"type":{"type":"string","enum":["group"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"name":{"type":"string","description":"The name of the group."}},"required":["type","id","name"],"additionalProperties":false,"title":"Group"}]}},"required":["id","createdAt","actor"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["members","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"addAgentVaultAccessBundleMembers","tags":["Agent Vault Access Bundles"],"description":"Grant an Agent Vault access bundle to users, machine identities or groups","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[],"description":"The IDs of the users to grant the access bundle to."},"machineIdentityIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[],"description":"The IDs of the machine identities to grant the access bundle to."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[],"description":"The IDs of the groups to grant the access bundle to."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the access bundle membership."},"accessBundleId":{"type":"string","format":"uuid","description":"The ID of the access bundle."},"createdAt":{"type":"string","format":"date-time","description":"When the access bundle was granted."},"actor":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Machine identity"},{"type":"object","properties":{"type":{"type":"string","enum":["group"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Group"}]}},"required":["id","accessBundleId","createdAt","actor"],"additionalProperties":false}},"skipped":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Machine identity"},{"type":"object","properties":{"type":{"type":"string","enum":["group"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Group"}]},"description":"The requested grantees who already had the access bundle and were left as they were."}},"required":["members","skipped"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/access-bundles/{accessBundleId}/members/available":{"get":{"operationId":"listAvailableAgentVaultAccessBundleMembers","tags":["Agent Vault Access Bundles"],"description":"List the Agent Vault members who can still be granted an access bundle","parameters":[{"schema":{"type":"string","maxLength":255,"pattern":"^[^\\x00-\\x1f\\x7f]*$"},"in":"query","name":"search","required":false,"description":"Match candidates by name, username or email address."},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false,"description":"The maximum number of candidates to return."},{"schema":{"type":"integer","minimum":0,"maximum":10000,"default":0},"in":"query","name":"offset","required":false,"description":"How many candidates to skip."},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the access bundle membership."},"role":{"type":"string","description":"The Agent Vault role: admin or member."},"isActive":{"type":"boolean","description":"Whether the member can currently reach Agent Vault."},"createdAt":{"type":"string","format":"date-time","description":"When the access bundle was granted."},"actor":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"username":{"type":"string","description":"The username of the user."},"email":{"type":"string","nullable":true,"description":"The email address of the user."},"firstName":{"type":"string","nullable":true,"description":"The first name of the user."},"lastName":{"type":"string","nullable":true,"description":"The last name of the user."},"isOrgMembershipPending":{"type":"boolean","description":"Whether the user still has an unaccepted invitation to the organization."}},"required":["type","id","username","email","firstName","lastName","isOrgMembershipPending"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"name":{"type":"string","description":"The name of the machine identity."},"isManagedByAgentVault":{"type":"boolean","description":"Whether Agent Vault created the machine identity. One it owns is deleted rather than removed."},"orgId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the organization the machine identity belongs to."}},"required":["type","id","name","isManagedByAgentVault","orgId"],"additionalProperties":false,"title":"Machine identity"},{"type":"object","properties":{"type":{"type":"string","enum":["group"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"name":{"type":"string","description":"The name of the group."}},"required":["type","id","name"],"additionalProperties":false,"title":"Group"}]}},"required":["id","role","isActive","createdAt","actor"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["members","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/access-bundles/{accessBundleId}/members/revoke":{"post":{"operationId":"revokeAgentVaultAccessBundleMembers","tags":["Agent Vault Access Bundles"],"description":"Revoke an Agent Vault access bundle from users, machine identities or groups","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[],"description":"The IDs of the users to revoke the access bundle from."},"machineIdentityIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[],"description":"The IDs of the machine identities to revoke the access bundle from."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[],"description":"The IDs of the groups to revoke the access bundle from."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"accessBundleId","required":true,"description":"The ID of the access bundle."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the access bundle membership."},"accessBundleId":{"type":"string","format":"uuid","description":"The ID of the access bundle."},"createdAt":{"type":"string","format":"date-time","description":"When the access bundle was granted."},"actor":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Machine identity"},{"type":"object","properties":{"type":{"type":"string","enum":["group"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Group"}]}},"required":["id","accessBundleId","createdAt","actor"],"additionalProperties":false}},"skipped":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Machine identity"},{"type":"object","properties":{"type":{"type":"string","enum":["group"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Group"}]},"description":"The requested grantees who did not have the access bundle, so nothing was revoked."}},"required":["members","skipped"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/sessions":{"get":{"operationId":"listAgentVaultSessions","tags":["Agent Vault Sessions"],"description":"List Agent Vault sessions","parameters":[{"schema":{"type":"string","enum":["mine","all"],"default":"mine"},"in":"query","name":"scope","required":false,"description":"Whose sessions to list: your own (mine) or everyone's (all, administrators only)."},{"schema":{"allOf":[{"anyOf":[{"not":{}},{"type":"string","maxLength":64}]},{"anyOf":[{"not":{}},{"type":"array","items":{"type":"string","enum":["active","revoked","expired"]}}]}]},"in":"query","name":"status","required":false,"description":"Filter by session status: `active`, `revoked` or `expired`. Separate several with commas to match any of them."},{"schema":{"type":"string","maxLength":255,"pattern":"^[^\\x00-\\x1f\\x7f]*$"},"in":"query","name":"search","required":false,"description":"Match sessions by actor name, actor email or access bundle name."},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false,"description":"The maximum number of sessions to return."},{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"How many sessions to skip."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"sessions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the session."},"actor":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether the session belongs to a user or a machine identity."},"id":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the user or machine identity the session belongs to, or null if it was deleted."},"username":{"type":"string","description":"The username of the user. Once the user is deleted, the email recorded when the session was created."},"email":{"type":"string","nullable":true,"description":"The email address of the user. Once the user is deleted, the email recorded when the session was created."},"firstName":{"type":"string","nullable":true,"description":"The first name of the user. Once the user is deleted, the full name recorded when the session was created."},"lastName":{"type":"string","nullable":true,"description":"The last name of the user, or null once the user is deleted."}},"required":["type","id","username","email","firstName","lastName"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether the session belongs to a user or a machine identity."},"id":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the user or machine identity the session belongs to, or null if it was deleted."},"name":{"type":"string","description":"The name of the machine identity. Once the machine identity is deleted, the name recorded when the session was created."}},"required":["type","id","name"],"additionalProperties":false,"title":"Machine identity"}]},"status":{"type":"string","enum":["active","revoked","expired"]},"expiresAt":{"type":"string","format":"date-time","nullable":true,"description":"When the session expires, or null when it never does."},"revokedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"accessBundles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","nullable":true},"name":{"type":"string"},"position":{"type":"number"}},"required":["id","name","position"],"additionalProperties":false}},"recentSessionLogCounts":{"type":"object","properties":{"recordedCount":{"type":"number","description":"The number of requests recorded in the session log."},"droppedCount":{"type":"number","description":"The number of requests the proxy couldn't record in the session log."}},"required":["recordedCount","droppedCount"],"additionalProperties":false,"description":"How many of the session's requests were recorded in its session log, and how many the proxy couldn't record, over the 24 hours before its most recent recorded request."}},"required":["id","actor","status","expiresAt","revokedAt","createdAt","accessBundles","recentSessionLogCounts"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["sessions","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAgentVaultSession","tags":["Agent Vault Sessions"],"description":"Create an Agent Vault session with an access bundle you can reach","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accessBundles":{"type":"array","items":{"type":"string","minLength":1,"maxLength":64},"minItems":1,"maxItems":1,"description":"The access bundle this session carries, by name. A list that accepts exactly one name."},"ttl":{"type":"string","default":"7d","description":"How long the session lasts: a duration such as 30m, 8h or 7d (at least 1m), or never. Defaults to 7d."}},"required":["accessBundles"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the session."},"token":{"type":"string","description":"The session token. Returned once, at mint, and never again."},"expiresAt":{"type":"string","format":"date-time","nullable":true,"description":"When the session expires, or null when it never does."},"createdAt":{"type":"string","format":"date-time"},"accessBundles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","nullable":true},"name":{"type":"string"},"position":{"type":"number"}},"required":["id","name","position"],"additionalProperties":false}}},"required":["id","token","expiresAt","createdAt","accessBundles"],"additionalProperties":false}},"required":["session"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/sessions/{sessionId}":{"get":{"operationId":"getAgentVaultSession","tags":["Agent Vault Sessions"],"description":"Gets an Agent Vault session.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"sessionId","required":true,"description":"The ID of the session."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the session."},"actor":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether the session belongs to a user or a machine identity."},"id":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the user or machine identity the session belongs to, or null if it was deleted."},"username":{"type":"string","description":"The username of the user. Once the user is deleted, the email recorded when the session was created."},"email":{"type":"string","nullable":true,"description":"The email address of the user. Once the user is deleted, the email recorded when the session was created."},"firstName":{"type":"string","nullable":true,"description":"The first name of the user. Once the user is deleted, the full name recorded when the session was created."},"lastName":{"type":"string","nullable":true,"description":"The last name of the user, or null once the user is deleted."}},"required":["type","id","username","email","firstName","lastName"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether the session belongs to a user or a machine identity."},"id":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the user or machine identity the session belongs to, or null if it was deleted."},"name":{"type":"string","description":"The name of the machine identity. Once the machine identity is deleted, the name recorded when the session was created."}},"required":["type","id","name"],"additionalProperties":false,"title":"Machine identity"}]},"status":{"type":"string","enum":["active","revoked","expired"]},"expiresAt":{"type":"string","format":"date-time","nullable":true,"description":"When the session expires, or null when it never does."},"revokedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"accessBundles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","nullable":true},"name":{"type":"string"},"position":{"type":"number"}},"required":["id","name","position"],"additionalProperties":false}},"recentSessionLogCounts":{"type":"object","properties":{"recordedCount":{"type":"number","description":"The number of requests recorded in the session log."},"droppedCount":{"type":"number","description":"The number of requests the proxy couldn't record in the session log."}},"required":["recordedCount","droppedCount"],"additionalProperties":false,"description":"How many of the session's requests were recorded in its session log, and how many the proxy couldn't record, over the 24 hours before its most recent recorded request."}},"required":["id","actor","status","expiresAt","revokedAt","createdAt","accessBundles","recentSessionLogCounts"],"additionalProperties":false}},"required":["session"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/sessions/{sessionId}/revoke":{"post":{"operationId":"revokeAgentVaultSession","tags":["Agent Vault Sessions"],"description":"Revoke an Agent Vault session","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"sessionId","required":true,"description":"The ID of the session."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"session":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the session."},"actor":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether the session belongs to a user or a machine identity."},"id":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the user or machine identity the session belongs to, or null if it was deleted."},"username":{"type":"string","description":"The username of the user. Once the user is deleted, the email recorded when the session was created."},"email":{"type":"string","nullable":true,"description":"The email address of the user. Once the user is deleted, the email recorded when the session was created."},"firstName":{"type":"string","nullable":true,"description":"The first name of the user. Once the user is deleted, the full name recorded when the session was created."},"lastName":{"type":"string","nullable":true,"description":"The last name of the user, or null once the user is deleted."}},"required":["type","id","username","email","firstName","lastName"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether the session belongs to a user or a machine identity."},"id":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the user or machine identity the session belongs to, or null if it was deleted."},"name":{"type":"string","description":"The name of the machine identity. Once the machine identity is deleted, the name recorded when the session was created."}},"required":["type","id","name"],"additionalProperties":false,"title":"Machine identity"}]},"status":{"type":"string","enum":["active","revoked","expired"]},"expiresAt":{"type":"string","format":"date-time","nullable":true,"description":"When the session expires, or null when it never does."},"revokedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"}},"required":["id","actor","status","expiresAt","revokedAt","createdAt"],"additionalProperties":false}},"required":["session"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/sessions/{sessionId}/logs":{"get":{"operationId":"listAgentVaultSessionLogs","tags":["Agent Vault Session Logs"],"description":"Lists a session's logs in chunks, newest first. A chunk is an encrypted batch of [records](/documentation/platform/agent-vault/session-logs#what-gets-recorded) that a proxy uploaded. To decrypt the chunks, follow [Reading session logs through the API](/documentation/platform/agent-vault/session-logs#reading-session-logs-through-the-api). To keep receiving new logs, pass `liveCursor` to [the endpoint that tails session logs](/api-reference/endpoints/agent-vault-session-logs/tail).","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":5000,"default":1000},"in":"query","name":"limit","required":false,"description":"How many records to return. Only whole chunks are returned, so a response can have slightly more."},{"schema":{"type":"string","maxLength":256},"in":"query","name":"cursor","required":false,"description":"The `nextCursor` from the previous response. Leave it out to start from the newest logs."},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"from","required":false,"description":"Return only chunks with records at or after this time."},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"to","required":false,"description":"Return only chunks with records at or before this time."},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"sessionId","required":true,"description":"The ID of the session."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"sessionLogs":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether session logs are on."},"isRecordable":{"type":"boolean","description":"False if this session's requests can't be recorded."},"sessionKey":{"type":"string","nullable":true,"description":"The key that decrypts every chunk in this response, as base64. Null if no chunk can be read."},"storageUnavailable":{"type":"object","properties":{"reason":{"type":"string","enum":["no-connection","connection-unusable"],"description":"`no-connection` if no AWS connection is set for session logs, or `connection-unusable` if Infisical can't use the AWS connection."},"message":{"type":"string","nullable":true,"description":"The error Infisical got from the AWS connection. Returned only to Agent Vault admins."}},"required":["reason","message"],"additionalProperties":false,"nullable":true,"description":"The reason the chunks can't be downloaded right now. Null if they can."}},"required":["enabled","isRecordable","sessionKey","storageUnavailable"],"additionalProperties":false,"description":"Whether session logs are on, the key that decrypts the chunks, and why they can't be downloaded, if they can't."},"chunks":{"type":"array","items":{"type":"object","properties":{"chunkId":{"type":"string","description":"The ID of the chunk."},"proxyId":{"type":"string","description":"The ID of the proxy that uploaded the chunk."},"proxyName":{"type":"string","description":"The name of the proxy that uploaded the chunk. If the proxy was deleted, the name it had at the time."},"startedAt":{"type":"string","format":"date-time","description":"The time of the first record in the chunk."},"endedAt":{"type":"string","format":"date-time","description":"The time of the last record in the chunk."},"firstSeq":{"type":"number","description":"The sequence number of the first record in the chunk. Each proxy numbers its own records."},"lastSeq":{"type":"number","description":"The sequence number of the last record in the chunk. Each proxy numbers its own records."},"recordCount":{"type":"number","description":"The number of records in the chunk."},"droppedCount":{"type":"number","description":"The number of requests the proxy couldn't record, for example because too many requests came in at once or session logs were off. They're reported on the next chunk the proxy sends, so they happened before this chunk, but not necessarily right before its first record."},"ciphertextBytes":{"type":"number","description":"The size of the encrypted chunk, in bytes."},"iv":{"type":"string","description":"The AES-GCM initialization vector for the chunk, as base64."},"ciphertextSha256":{"type":"string","description":"The SHA-256 digest of the encrypted chunk, as base64 without padding. If the downloaded chunk has a different digest, the chunk was changed after it was uploaded."},"presignedGetUrl":{"type":"string","nullable":true,"description":"The URL to download the chunk from. Null if the chunk is in a bucket session logs no longer use, or if `sessionLogs.storageUnavailable` is set."},"createdAt":{"type":"string","format":"date-time","description":"When the proxy registered the chunk with Infisical. Its upload to the bucket finishes shortly after, so a download in between returns 404."}},"required":["chunkId","proxyId","proxyName","startedAt","endedAt","firstSeq","lastSeq","recordCount","droppedCount","ciphertextBytes","iv","ciphertextSha256","presignedGetUrl","createdAt"],"additionalProperties":false}},"nextCursor":{"type":"string","nullable":true,"description":"Pass this as `cursor` to get older logs. Null when there's nothing older."},"liveCursor":{"type":"string","description":"Pass this to [the endpoint that tails session logs](/api-reference/endpoints/agent-vault-session-logs/tail) to get new logs as they arrive."}},"required":["sessionLogs","chunks","nextCursor","liveCursor"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/sessions/{sessionId}/logs/tail":{"get":{"operationId":"tailAgentVaultSessionLogs","tags":["Agent Vault Session Logs"],"description":"Lists a session's new logs since your last call, oldest first. The same chunk can appear in more than one response, so skip any `chunkId` you've already read. The chunks decrypt the same way as the ones from [the endpoint that lists session logs](/api-reference/endpoints/agent-vault-session-logs/list).","parameters":[{"schema":{"type":"integer","minimum":1,"maximum":5000,"default":1000},"in":"query","name":"limit","required":false,"description":"How many records to return. Only whole chunks are returned, so a response can have slightly more."},{"schema":{"type":"string","maxLength":256},"in":"query","name":"cursor","required":false,"description":"The `liveCursor` from [the endpoint that lists session logs](/api-reference/endpoints/agent-vault-session-logs/list), or the `nextCursor` from your last call. Leave it out to start from now."},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"sessionId","required":true,"description":"The ID of the session."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"sessionLogs":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether session logs are on."},"isRecordable":{"type":"boolean","description":"False if this session's requests can't be recorded."},"sessionKey":{"type":"string","nullable":true,"description":"The key that decrypts every chunk in this response, as base64. Null if no chunk can be read."},"storageUnavailable":{"type":"object","properties":{"reason":{"type":"string","enum":["no-connection","connection-unusable"],"description":"`no-connection` if no AWS connection is set for session logs, or `connection-unusable` if Infisical can't use the AWS connection."},"message":{"type":"string","nullable":true,"description":"The error Infisical got from the AWS connection. Returned only to Agent Vault admins."}},"required":["reason","message"],"additionalProperties":false,"nullable":true,"description":"The reason the chunks can't be downloaded right now. Null if they can."}},"required":["enabled","isRecordable","sessionKey","storageUnavailable"],"additionalProperties":false,"description":"Whether session logs are on, the key that decrypts the chunks, and why they can't be downloaded, if they can't."},"chunks":{"type":"array","items":{"type":"object","properties":{"chunkId":{"type":"string","description":"The ID of the chunk."},"proxyId":{"type":"string","description":"The ID of the proxy that uploaded the chunk."},"proxyName":{"type":"string","description":"The name of the proxy that uploaded the chunk. If the proxy was deleted, the name it had at the time."},"startedAt":{"type":"string","format":"date-time","description":"The time of the first record in the chunk."},"endedAt":{"type":"string","format":"date-time","description":"The time of the last record in the chunk."},"firstSeq":{"type":"number","description":"The sequence number of the first record in the chunk. Each proxy numbers its own records."},"lastSeq":{"type":"number","description":"The sequence number of the last record in the chunk. Each proxy numbers its own records."},"recordCount":{"type":"number","description":"The number of records in the chunk."},"droppedCount":{"type":"number","description":"The number of requests the proxy couldn't record, for example because too many requests came in at once or session logs were off. They're reported on the next chunk the proxy sends, so they happened before this chunk, but not necessarily right before its first record."},"ciphertextBytes":{"type":"number","description":"The size of the encrypted chunk, in bytes."},"iv":{"type":"string","description":"The AES-GCM initialization vector for the chunk, as base64."},"ciphertextSha256":{"type":"string","description":"The SHA-256 digest of the encrypted chunk, as base64 without padding. If the downloaded chunk has a different digest, the chunk was changed after it was uploaded."},"presignedGetUrl":{"type":"string","nullable":true,"description":"The URL to download the chunk from. Null if the chunk is in a bucket session logs no longer use, or if `sessionLogs.storageUnavailable` is set."},"createdAt":{"type":"string","format":"date-time","description":"When the proxy registered the chunk with Infisical. Its upload to the bucket finishes shortly after, so a download in between returns 404."}},"required":["chunkId","proxyId","proxyName","startedAt","endedAt","firstSeq","lastSeq","recordCount","droppedCount","ciphertextBytes","iv","ciphertextSha256","presignedGetUrl","createdAt"],"additionalProperties":false}},"nextCursor":{"type":"string","description":"Pass this as `cursor` on your next call."},"hasMore":{"type":"boolean","description":"Whether more logs are ready now. If false, wait a few seconds before calling again."}},"required":["sessionLogs","chunks","nextCursor","hasMore"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/settings/session-logs":{"get":{"operationId":"getAgentVaultSessionLogSettings","tags":["Agent Vault Settings"],"description":"Gets the session log settings","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether session logs are on. Turning them off stops recording but keeps what's already recorded."},"appConnectionId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the AWS connection Infisical uses to write to and read from the bucket."},"bucket":{"type":"string","nullable":true,"description":"The name of the S3 bucket. 3 to 63 characters: lowercase letters, numbers, dots and hyphens, starting and ending with a letter or number."},"region":{"type":"string","nullable":true,"description":"The AWS region of the bucket."},"keyPrefix":{"type":"string","nullable":true,"description":"The folder in the bucket to store session logs in, such as `logs/agent-vault`. Up to 512 characters: letters, numbers and `! - _ . ' ( ) /`, with no slash at the start or end, no empty folder name, and no folder named `.` or `..`."}},"required":["enabled","appConnectionId","bucket","region","keyPrefix"],"additionalProperties":false}},"required":["settings"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAgentVaultSessionLogSettings","tags":["Agent Vault Settings"],"description":"Updates the session log settings","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether session logs are on. Turning them off stops recording but keeps what's already recorded."},"appConnectionId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the AWS connection Infisical uses to write to and read from the bucket."},"bucket":{"type":"string","maxLength":63,"pattern":"^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$","description":"The name of the S3 bucket. 3 to 63 characters: lowercase letters, numbers, dots and hyphens, starting and ending with a letter or number."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region of the bucket."},"keyPrefix":{"type":"string","maxLength":512,"pattern":"^[A-Za-z0-9!\\-_.'()/]*$","description":"The folder in the bucket to store session logs in, such as `logs/agent-vault`. Up to 512 characters: letters, numbers and `! - _ . ' ( ) /`, with no slash at the start or end, no empty folder name, and no folder named `.` or `..`."}},"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether session logs are on. Turning them off stops recording but keeps what's already recorded."},"appConnectionId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the AWS connection Infisical uses to write to and read from the bucket."},"bucket":{"type":"string","nullable":true,"description":"The name of the S3 bucket. 3 to 63 characters: lowercase letters, numbers, dots and hyphens, starting and ending with a letter or number."},"region":{"type":"string","nullable":true,"description":"The AWS region of the bucket."},"keyPrefix":{"type":"string","nullable":true,"description":"The folder in the bucket to store session logs in, such as `logs/agent-vault`. Up to 512 characters: letters, numbers and `! - _ . ' ( ) /`, with no slash at the start or end, no empty folder name, and no folder named `.` or `..`."}},"required":["enabled","appConnectionId","bucket","region","keyPrefix"],"additionalProperties":false}},"required":["settings"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/app-connections/aws":{"get":{"operationId":"listAgentVaultAwsAppConnections","tags":["Agent Vault App Connections"],"description":"Lists the AWS connections scoped to Agent Vault","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["assume-role"]},"credentials":{"type":"object","properties":{"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Assume Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1}},"required":["accessKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Access Key)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAgentVaultAwsAppConnection","tags":["Agent Vault App Connections"],"description":"Creates an AWS connection scoped to Agent Vault. Only Agent Vault can use the connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["assume-role"],"description":"The method used to authenticate with AWS."},"credentials":{"type":"object","properties":{"roleArn":{"type":"string","minLength":1},"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"required":["roleArn"],"additionalProperties":false,"description":"The credentials used to connect with AWS."}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["access-key"],"description":"The method used to authenticate with AWS."},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1},"secretAccessKey":{"type":"string","minLength":1}},"required":["accessKeyId","secretAccessKey"],"additionalProperties":false,"description":"The credentials used to connect with AWS."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the AWS Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the AWS Connection."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["assume-role"]},"credentials":{"type":"object","properties":{"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Assume Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1}},"required":["accessKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Access Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/app-connections/aws/{connectionId}":{"get":{"operationId":"getAgentVaultAwsAppConnection","tags":["Agent Vault App Connections"],"description":"Gets an AWS connection scoped to Agent Vault","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the AWS Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["assume-role"]},"credentials":{"type":"object","properties":{"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Assume Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1}},"required":["accessKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Access Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAgentVaultAwsAppConnection","tags":["Agent Vault App Connections"],"description":"Updates an AWS connection scoped to Agent Vault","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"anyOf":[{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1},"secretAccessKey":{"type":"string","minLength":1}},"required":["accessKeyId","secretAccessKey"],"additionalProperties":false},{"type":"object","properties":{"roleArn":{"type":"string","minLength":1},"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"required":["roleArn"],"additionalProperties":false}],"description":"The credentials used to connect with AWS."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the AWS Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the AWS Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for AWS Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for AWS Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for AWS Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for AWS Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for AWS Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the AWS Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["assume-role"]},"credentials":{"type":"object","properties":{"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Assume Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1}},"required":["accessKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Access Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAgentVaultAwsAppConnection","tags":["Agent Vault App Connections"],"description":"Deletes an AWS connection scoped to Agent Vault. If session logs use the connection, switch them to another connection or to none first.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the AWS Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["assume-role"]},"credentials":{"type":"object","properties":{"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Assume Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1}},"required":["accessKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Access Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/proxies":{"get":{"operationId":"listAgentVaultProxies","tags":["Agent Vault Proxies"],"description":"List the organization's Agent Vault proxies","parameters":[{"schema":{"type":"string","enum":["name","createdAt"],"default":"createdAt"},"in":"query","name":"orderBy","required":false,"description":"What to sort proxies by: name or createdAt."},{"schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"in":"query","name":"orderDirection","required":false,"description":"Which way to sort: asc or desc."},{"schema":{"type":"string","maxLength":255,"pattern":"^[^\\x00-\\x1f\\x7f]*$"},"in":"query","name":"search","required":false,"description":"Match proxies by name."},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false,"description":"The maximum number of proxies to return."},{"schema":{"type":"integer","minimum":0,"maximum":10000,"default":0},"in":"query","name":"offset","required":false,"description":"How many proxies to skip."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"proxies":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the proxy."},"name":{"type":"string","description":"The name of the proxy."},"heartbeat":{"type":"string","format":"date-time","nullable":true,"description":"When the proxy last checked in, or `null` if it never has."},"isHealthy":{"type":"boolean","description":"Whether the proxy has checked in recently enough to be considered up."},"rootCaFingerprint":{"type":"string","nullable":true,"description":"The SHA-256 fingerprint of the proxy's certificate authority. Pin this if you want to verify the proxy an agent connects to."},"rootCaExpiresAt":{"type":"string","format":"date-time","nullable":true,"description":"When the proxy's certificate authority expires."},"trafficPolicy":{"type":"string","enum":["any-host","bundle-hosts"],"description":"Which hosts an agent may reach through this proxy. `any-host` lets every request out; `bundle-hosts` allows only hosts an access bundle covers, plus anything in `allowedHosts`, and refuses the rest with a 403."},"allowedHosts":{"type":"string","nullable":true,"description":"Hosts that stay reachable under the `bundle-hosts` traffic policy even though no access bundle covers them. Still intercepted, and given no credential."},"pollInterval":{"type":"number","description":"How often, in seconds, the proxy refreshes its sessions and settings. Between 10 and 300."},"createdAt":{"type":"string","format":"date-time","description":"When the proxy was registered."}},"required":["id","name","heartbeat","isHealthy","rootCaFingerprint","rootCaExpiresAt","trafficPolicy","allowedHosts","pollInterval","createdAt"],"additionalProperties":false,"title":"Admin view"},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the proxy."},"name":{"type":"string","description":"The name of the proxy."},"heartbeat":{"type":"string","format":"date-time","nullable":true,"description":"When the proxy last checked in, or `null` if it never has."},"isHealthy":{"type":"boolean","description":"Whether the proxy has checked in recently enough to be considered up."},"rootCaFingerprint":{"type":"string","nullable":true,"description":"The SHA-256 fingerprint of the proxy's certificate authority. Pin this if you want to verify the proxy an agent connects to."},"rootCaExpiresAt":{"type":"string","format":"date-time","nullable":true,"description":"When the proxy's certificate authority expires."}},"required":["id","name","heartbeat","isHealthy","rootCaFingerprint","rootCaExpiresAt"],"additionalProperties":false,"title":"Member view"}]}},"totalCount":{"type":"number"}},"required":["proxies","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAgentVaultProxy","tags":["Agent Vault Proxies"],"description":"Register an Agent Vault proxy and issue its one-time enrollment token","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the proxy."},"trafficPolicy":{"type":"string","enum":["any-host","bundle-hosts"],"description":"Which hosts an agent may reach through this proxy. `any-host` lets every request out; `bundle-hosts` allows only hosts an access bundle covers, plus anything in `allowedHosts`, and refuses the rest with a 403.","default":"any-host"},"allowedHosts":{"type":"string","maxLength":1024,"nullable":true,"description":"Hosts that stay reachable under the `bundle-hosts` traffic policy even though no access bundle covers them. Still intercepted, and given no credential.","default":null},"pollInterval":{"type":"integer","minimum":10,"maximum":300,"description":"How often, in seconds, the proxy refreshes its sessions and settings. Between 10 and 300.","default":60}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"proxy":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the proxy."},"name":{"type":"string","description":"The name of the proxy."},"heartbeat":{"type":"string","format":"date-time","nullable":true,"description":"When the proxy last checked in, or `null` if it never has."},"isHealthy":{"type":"boolean","description":"Whether the proxy has checked in recently enough to be considered up."},"rootCaFingerprint":{"type":"string","nullable":true,"description":"The SHA-256 fingerprint of the proxy's certificate authority. Pin this if you want to verify the proxy an agent connects to."},"rootCaExpiresAt":{"type":"string","format":"date-time","nullable":true,"description":"When the proxy's certificate authority expires."},"trafficPolicy":{"type":"string","enum":["any-host","bundle-hosts"],"description":"Which hosts an agent may reach through this proxy. `any-host` lets every request out; `bundle-hosts` allows only hosts an access bundle covers, plus anything in `allowedHosts`, and refuses the rest with a 403."},"allowedHosts":{"type":"string","nullable":true,"description":"Hosts that stay reachable under the `bundle-hosts` traffic policy even though no access bundle covers them. Still intercepted, and given no credential."},"pollInterval":{"type":"number","description":"How often, in seconds, the proxy refreshes its sessions and settings. Between 10 and 300."},"createdAt":{"type":"string","format":"date-time","description":"When the proxy was registered."}},"required":["id","name","heartbeat","isHealthy","rootCaFingerprint","rootCaExpiresAt","trafficPolicy","allowedHosts","pollInterval","createdAt"],"additionalProperties":false,"title":"Admin view"},"token":{"type":"string","description":"A one-time token the proxy enrolls with. Shown once, and valid for one hour."},"expiresAt":{"type":"string","format":"date-time"}},"required":["proxy","token","expiresAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/proxies/{proxyId}":{"patch":{"operationId":"updateAgentVaultProxy","tags":["Agent Vault Proxies"],"description":"Update an Agent Vault proxy's name or settings","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the proxy."},"trafficPolicy":{"type":"string","enum":["any-host","bundle-hosts"],"description":"Which hosts an agent may reach through this proxy. `any-host` lets every request out; `bundle-hosts` allows only hosts an access bundle covers, plus anything in `allowedHosts`, and refuses the rest with a 403."},"allowedHosts":{"type":"string","maxLength":1024,"nullable":true,"description":"Hosts that stay reachable under the `bundle-hosts` traffic policy even though no access bundle covers them. Still intercepted, and given no credential."},"pollInterval":{"type":"integer","minimum":10,"maximum":300,"description":"How often, in seconds, the proxy refreshes its sessions and settings. Between 10 and 300."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"proxyId","required":true,"description":"The ID of the proxy."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"proxy":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the proxy."},"name":{"type":"string","description":"The name of the proxy."},"heartbeat":{"type":"string","format":"date-time","nullable":true,"description":"When the proxy last checked in, or `null` if it never has."},"isHealthy":{"type":"boolean","description":"Whether the proxy has checked in recently enough to be considered up."},"rootCaFingerprint":{"type":"string","nullable":true,"description":"The SHA-256 fingerprint of the proxy's certificate authority. Pin this if you want to verify the proxy an agent connects to."},"rootCaExpiresAt":{"type":"string","format":"date-time","nullable":true,"description":"When the proxy's certificate authority expires."},"trafficPolicy":{"type":"string","enum":["any-host","bundle-hosts"],"description":"Which hosts an agent may reach through this proxy. `any-host` lets every request out; `bundle-hosts` allows only hosts an access bundle covers, plus anything in `allowedHosts`, and refuses the rest with a 403."},"allowedHosts":{"type":"string","nullable":true,"description":"Hosts that stay reachable under the `bundle-hosts` traffic policy even though no access bundle covers them. Still intercepted, and given no credential."},"pollInterval":{"type":"number","description":"How often, in seconds, the proxy refreshes its sessions and settings. Between 10 and 300."},"createdAt":{"type":"string","format":"date-time","description":"When the proxy was registered."}},"required":["id","name","heartbeat","isHealthy","rootCaFingerprint","rootCaExpiresAt","trafficPolicy","allowedHosts","pollInterval","createdAt"],"additionalProperties":false,"title":"Admin view"}},"required":["proxy"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAgentVaultProxy","tags":["Agent Vault Proxies"],"description":"Delete an Agent Vault proxy","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"proxyId","required":true,"description":"The ID of the proxy."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"proxy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"required":["proxy"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/proxies/{proxyId}/token-auth/enrollment-token":{"post":{"operationId":"reissueAgentVaultProxyEnrollmentToken","tags":["Agent Vault Proxies"],"description":"Issue a replacement enrollment token for an Agent Vault proxy","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"proxyId","required":true,"description":"The ID of the proxy."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"A one-time token the proxy enrolls with. Shown once, and valid for one hour."},"expiresAt":{"type":"string","format":"date-time"}},"required":["token","expiresAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/proxies/{proxyId}/revoke":{"post":{"operationId":"revokeAgentVaultProxyAccess","tags":["Agent Vault Proxies"],"description":"Revoke an Agent Vault proxy's access token","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"proxyId","required":true,"description":"The ID of the proxy."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"proxy":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the proxy."},"name":{"type":"string","description":"The name of the proxy."},"heartbeat":{"type":"string","format":"date-time","nullable":true,"description":"When the proxy last checked in, or `null` if it never has."},"isHealthy":{"type":"boolean","description":"Whether the proxy has checked in recently enough to be considered up."},"rootCaFingerprint":{"type":"string","nullable":true,"description":"The SHA-256 fingerprint of the proxy's certificate authority. Pin this if you want to verify the proxy an agent connects to."},"rootCaExpiresAt":{"type":"string","format":"date-time","nullable":true,"description":"When the proxy's certificate authority expires."},"trafficPolicy":{"type":"string","enum":["any-host","bundle-hosts"],"description":"Which hosts an agent may reach through this proxy. `any-host` lets every request out; `bundle-hosts` allows only hosts an access bundle covers, plus anything in `allowedHosts`, and refuses the rest with a 403."},"allowedHosts":{"type":"string","nullable":true,"description":"Hosts that stay reachable under the `bundle-hosts` traffic policy even though no access bundle covers them. Still intercepted, and given no credential."},"pollInterval":{"type":"number","description":"How often, in seconds, the proxy refreshes its sessions and settings. Between 10 and 300."},"createdAt":{"type":"string","format":"date-time","description":"When the proxy was registered."}},"required":["id","name","heartbeat","isHealthy","rootCaFingerprint","rootCaExpiresAt","trafficPolicy","allowedHosts","pollInterval","createdAt"],"additionalProperties":false,"title":"Admin view"}},"required":["proxy"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/members":{"get":{"operationId":"listAgentVaultMembers","tags":["Agent Vault Members"],"description":"List the users, groups and machine identities that are members of Agent Vault","parameters":[{"schema":{"type":"string","enum":["user","machineIdentity","group"]},"in":"query","name":"actorType","required":false,"description":"List only users, only groups or only machine identities."},{"schema":{"type":"string","maxLength":255,"pattern":"^[^\\x00-\\x1f\\x7f]*$"},"in":"query","name":"search","required":false,"description":"Match members by name, username or email address."},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false,"description":"The maximum number of members to return."},{"schema":{"type":"integer","minimum":0,"maximum":10000,"default":0},"in":"query","name":"offset","required":false,"description":"How many members to skip."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the access bundle membership."},"role":{"type":"string","description":"The Agent Vault role: admin or member."},"isActive":{"type":"boolean","description":"Whether the member can currently reach Agent Vault."},"createdAt":{"type":"string","format":"date-time","description":"When the access bundle was granted."},"actor":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"username":{"type":"string","description":"The username of the user."},"email":{"type":"string","nullable":true,"description":"The email address of the user."},"firstName":{"type":"string","nullable":true,"description":"The first name of the user."},"lastName":{"type":"string","nullable":true,"description":"The last name of the user."},"isOrgMembershipPending":{"type":"boolean","description":"Whether the user still has an unaccepted invitation to the organization."}},"required":["type","id","username","email","firstName","lastName","isOrgMembershipPending"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"name":{"type":"string","description":"The name of the machine identity."},"isManagedByAgentVault":{"type":"boolean","description":"Whether Agent Vault created the machine identity. One it owns is deleted rather than removed."},"orgId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the organization the machine identity belongs to."}},"required":["type","id","name","isManagedByAgentVault","orgId"],"additionalProperties":false,"title":"Machine identity"},{"type":"object","properties":{"type":{"type":"string","enum":["group"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"name":{"type":"string","description":"The name of the group."}},"required":["type","id","name"],"additionalProperties":false,"title":"Group"}]}},"required":["id","role","isActive","createdAt","actor"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["members","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"addAgentVaultMembers","tags":["Agent Vault Members"],"description":"Give users, groups and machine identities access to Agent Vault, by id or by email","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[],"description":"The IDs of the users to act on."},"machineIdentityIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[],"description":"The IDs of the machine identities to act on."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[],"description":"The IDs of the groups to act on."},"emails":{"type":"array","items":{"type":"string","format":"email"},"default":[],"description":"The email addresses of the users to give access to. Each must already be in the organization."},"role":{"type":"string","enum":["admin","member"],"description":"The Agent Vault role: admin or member."}},"required":["role"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the access bundle membership."},"role":{"type":"string","description":"The Agent Vault role: admin or member."},"createdAt":{"type":"string","format":"date-time","description":"When the access bundle was granted."},"actor":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Machine identity"},{"type":"object","properties":{"type":{"type":"string","enum":["group"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Group"}]}},"required":["id","role","createdAt","actor"],"additionalProperties":false}},"skipped":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"identifier":{"type":"string","description":"The ID or email address the request named, echoed back so a reply can be matched to it."}},"required":["type","id","identifier"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"identifier":{"type":"string","description":"The ID or email address the request named, echoed back so a reply can be matched to it."}},"required":["type","id","identifier"],"additionalProperties":false,"title":"Machine identity"},{"type":"object","properties":{"type":{"type":"string","enum":["group"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"identifier":{"type":"string","description":"The ID or email address the request named, echoed back so a reply can be matched to it."}},"required":["type","id","identifier"],"additionalProperties":false,"title":"Group"}]},"description":"The requested members who already had access to Agent Vault and were left as they were."}},"required":["members","skipped"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/members/available":{"get":{"operationId":"listAvailableAgentVaultMembers","tags":["Agent Vault Members"],"description":"List the users, groups and machine identities in the organization that can be added to Agent Vault","parameters":[{"schema":{"type":"string","enum":["user","machineIdentity","group"]},"in":"query","name":"actorType","required":false,"description":"List only users, only groups or only machine identities."},{"schema":{"type":"string","maxLength":255,"pattern":"^[^\\x00-\\x1f\\x7f]*$"},"in":"query","name":"search","required":false,"description":"Match candidates by name, username or email address."},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false,"description":"The maximum number of candidates to return."},{"schema":{"type":"integer","minimum":0,"maximum":10000,"default":0},"in":"query","name":"offset","required":false,"description":"How many candidates to skip."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"actors":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"username":{"type":"string","description":"The username of the user."},"email":{"type":"string","nullable":true,"description":"The email address of the user."},"firstName":{"type":"string","nullable":true,"description":"The first name of the user."},"lastName":{"type":"string","nullable":true,"description":"The last name of the user."},"isOrgMembershipPending":{"type":"boolean","description":"Whether the user still has an unaccepted invitation to the organization."}},"required":["type","id","username","email","firstName","lastName","isOrgMembershipPending"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"name":{"type":"string","description":"The name of the machine identity."},"isManagedByAgentVault":{"type":"boolean","description":"Whether Agent Vault created the machine identity. One it owns is deleted rather than removed."},"orgId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the organization the machine identity belongs to."}},"required":["type","id","name","isManagedByAgentVault","orgId"],"additionalProperties":false,"title":"Machine identity"},{"type":"object","properties":{"type":{"type":"string","enum":["group"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"name":{"type":"string","description":"The name of the group."}},"required":["type","id","name"],"additionalProperties":false,"title":"Group"}]}},"totalCount":{"type":"number"}},"required":["actors","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/members/{actorType}/{actorId}":{"patch":{"operationId":"updateAgentVaultMemberRole","tags":["Agent Vault Members"],"description":"Change a member's Agent Vault role","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","enum":["admin","member"],"description":"The Agent Vault role: admin or member."}},"required":["role"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","enum":["users","groups","machine-identities"]},"in":"path","name":"actorType","required":true,"description":"Whether this member is a user, a machine identity or a group."},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"actorId","required":true,"description":"The ID of the user, machine identity or group."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"member":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the access bundle membership."},"role":{"type":"string","description":"The Agent Vault role: admin or member."},"createdAt":{"type":"string","format":"date-time","description":"When the access bundle was granted."},"actor":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Machine identity"},{"type":"object","properties":{"type":{"type":"string","enum":["group"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Group"}]}},"required":["id","role","createdAt","actor"],"additionalProperties":false}},"required":["member"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/agent-vault/members/revoke":{"post":{"operationId":"revokeAgentVaultMembers","tags":["Agent Vault Members"],"description":"Remove members from Agent Vault, and with them every bundle they hold","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[],"description":"The IDs of the users to act on."},"machineIdentityIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[],"description":"The IDs of the machine identities to act on."},"groupIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[],"description":"The IDs of the groups to act on."}},"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the access bundle membership."},"createdAt":{"type":"string","format":"date-time","description":"When the access bundle was granted."},"actor":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Machine identity"},{"type":"object","properties":{"type":{"type":"string","enum":["group"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."}},"required":["type","id"],"additionalProperties":false,"title":"Group"}]}},"required":["id","createdAt","actor"],"additionalProperties":false}},"skipped":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"identifier":{"type":"string","description":"The ID or email address the request named, echoed back so a reply can be matched to it."}},"required":["type","id","identifier"],"additionalProperties":false,"title":"User"},{"type":"object","properties":{"type":{"type":"string","enum":["machineIdentity"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"identifier":{"type":"string","description":"The ID or email address the request named, echoed back so a reply can be matched to it."}},"required":["type","id","identifier"],"additionalProperties":false,"title":"Machine identity"},{"type":"object","properties":{"type":{"type":"string","enum":["group"],"description":"Whether this member is a user, a machine identity or a group."},"id":{"type":"string","format":"uuid","description":"The ID of the user, machine identity or group."},"identifier":{"type":"string","description":"The ID or email address the request named, echoed back so a reply can be matched to it."}},"required":["type","id","identifier"],"additionalProperties":false,"title":"Group"}]},"description":"The requested members who did not have access to Agent Vault, so nothing was removed."}},"required":["members","skipped"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/token-auth/identities/{identityId}":{"post":{"operationId":"attachTokenAuth","tags":["Token Auth"],"description":"Attach Token Auth configuration onto machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to attach the configuration onto."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityTokenAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId"],"additionalProperties":false}},"required":["identityTokenAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateTokenAuth","tags":["Token Auth"],"description":"Update Token Auth configuration on machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"description":"The new IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"description":"The new maximum number of times that an access token can be used."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new maximum lifetime for an access token in seconds."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityTokenAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId"],"additionalProperties":false}},"required":["identityTokenAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getTokenAuth","tags":["Token Auth"],"description":"Retrieve Token Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to retrieve the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityTokenAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId"],"additionalProperties":false}},"required":["identityTokenAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteTokenAuth","tags":["Token Auth"],"description":"Delete Token Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityTokenAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId"],"additionalProperties":false}},"required":["identityTokenAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/token-auth/identities/{identityId}/tokens":{"post":{"operationId":"createTokenAuthToken","tags":["Token Auth"],"description":"Create token for machine identity with Token Auth","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the token to create."},"organizationSlug":{"type":"string","minLength":1,"maxLength":64,"description":"The sub organization name to scope the token to."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to create the token for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]},"tokenData":{"type":"object","properties":{"id":{"type":"string"},"accessTokenTTL":{"type":"number","default":2592000},"accessTokenMaxTTL":{"type":"number","default":2592000},"accessTokenNumUses":{"type":"number","default":0},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenLastUsedAt":{"type":"string","format":"date-time","nullable":true},"accessTokenLastRenewedAt":{"type":"string","format":"date-time","nullable":true},"isAccessTokenRevoked":{"type":"boolean","default":false},"identityUAClientSecretId":{"type":"string","nullable":true},"identityId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string","nullable":true},"authMethod":{"type":"string"},"accessTokenPeriod":{"type":"number","default":0},"subOrganizationId":{"type":"string","format":"uuid","nullable":true}},"required":["id","identityId","createdAt","updatedAt","authMethod"],"additionalProperties":false}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType","tokenData"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getTokenAuthTokens","tags":["Token Auth"],"description":"Get tokens for machine identity with Token Auth","parameters":[{"schema":{"type":"number","minimum":0,"maximum":100,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th token."},{"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false,"description":"The number of tokens to return."},{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to list token metadata for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"tokens":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"accessTokenTTL":{"type":"number","default":2592000},"accessTokenMaxTTL":{"type":"number","default":2592000},"accessTokenNumUses":{"type":"number","default":0},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenLastUsedAt":{"type":"string","format":"date-time","nullable":true},"accessTokenLastRenewedAt":{"type":"string","format":"date-time","nullable":true},"isAccessTokenRevoked":{"type":"boolean","default":false},"identityUAClientSecretId":{"type":"string","nullable":true},"identityId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string","nullable":true},"authMethod":{"type":"string"},"accessTokenPeriod":{"type":"number","default":0},"subOrganizationId":{"type":"string","format":"uuid","nullable":true}},"required":["id","identityId","createdAt","updatedAt","authMethod"],"additionalProperties":false}}},"required":["tokens"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/token-auth/tokens/{tokenId}":{"get":{"operationId":"getTokenAuthTokenById","tags":["Token Auth"],"description":"Get token for machine identity with Token Auth","parameters":[{"schema":{"type":"string"},"in":"path","name":"tokenId","required":true,"description":"The ID of the token to get metadata for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"object","properties":{"id":{"type":"string"},"accessTokenTTL":{"type":"number","default":2592000},"accessTokenMaxTTL":{"type":"number","default":2592000},"accessTokenNumUses":{"type":"number","default":0},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenLastUsedAt":{"type":"string","format":"date-time","nullable":true},"accessTokenLastRenewedAt":{"type":"string","format":"date-time","nullable":true},"isAccessTokenRevoked":{"type":"boolean","default":false},"identityUAClientSecretId":{"type":"string","nullable":true},"identityId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string","nullable":true},"authMethod":{"type":"string"},"accessTokenPeriod":{"type":"number","default":0},"subOrganizationId":{"type":"string","format":"uuid","nullable":true}},"required":["id","identityId","createdAt","updatedAt","authMethod"],"additionalProperties":false}},"required":["token"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateTokenAuthToken","tags":["Token Auth"],"description":"Update token for machine identity with Token Auth","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the token to update to."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"tokenId","required":true,"description":"The ID of the token to update metadata for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"object","properties":{"id":{"type":"string"},"accessTokenTTL":{"type":"number","default":2592000},"accessTokenMaxTTL":{"type":"number","default":2592000},"accessTokenNumUses":{"type":"number","default":0},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenLastUsedAt":{"type":"string","format":"date-time","nullable":true},"accessTokenLastRenewedAt":{"type":"string","format":"date-time","nullable":true},"isAccessTokenRevoked":{"type":"boolean","default":false},"identityUAClientSecretId":{"type":"string","nullable":true},"identityId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"name":{"type":"string","nullable":true},"authMethod":{"type":"string"},"accessTokenPeriod":{"type":"number","default":0},"subOrganizationId":{"type":"string","format":"uuid","nullable":true}},"required":["id","identityId","createdAt","updatedAt","authMethod"],"additionalProperties":false}},"required":["token"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/token-auth/tokens/{tokenId}/revoke":{"post":{"operationId":"revokeTokenAuthToken","tags":["Token Auth"],"description":"Revoke token for machine identity with Token Auth","parameters":[{"schema":{"type":"string"},"in":"path","name":"tokenId","required":true,"description":"The ID of the token to revoke."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/universal-auth/login":{"post":{"operationId":"loginWithUniversalAuth","tags":["Universal Auth"],"description":"Login with Universal Auth for machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"clientId":{"type":"string","description":"Your Machine Identity Client ID."},"clientSecret":{"type":"string","description":"Your Machine Identity Client Secret."},"organizationSlug":{"type":"string","minLength":1,"maxLength":64,"description":"When set, this will scope the login session to the specified organization the machine identity has access to. If omitted, the session defaults to the organization where the machine identity was created in."}},"required":["clientId","clientSecret"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/universal-auth/identities/{identityId}":{"post":{"operationId":"attachUniversalAuth","tags":["Universal Auth"],"description":"Attach Universal Auth configuration onto machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"clientSecretTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"A list of IPs or CIDR ranges that the Client Secret can be used from together with the Client ID to get back an access token. You can use 0.0.0.0/0, to allow usage from any network address."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"A list of IPs or CIDR ranges that access tokens can be used from. You can use 0.0.0.0/0, to allow usage from any network address."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds. This value will be referenced at renewal time."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds. This value will be referenced at renewal time."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used; a value of 0 implies infinite number of uses."},"accessTokenPeriod":{"type":"integer","minimum":0,"default":0,"description":"The period for an access token in seconds. This value will be referenced at renewal time. Default value is 0."},"lockoutEnabled":{"type":"boolean","default":true,"description":"Whether the lockout feature is enabled."},"lockoutThreshold":{"type":"number","minimum":1,"maximum":30,"default":3,"description":"The amount of times login must fail before locking the identity auth method."},"lockoutDurationSeconds":{"type":"number","minimum":30,"maximum":86400,"default":300,"description":"How long an identity auth method lockout lasts."},"lockoutCounterResetSeconds":{"type":"number","minimum":5,"maximum":3600,"default":30,"description":"How long to wait from the most recent failed login until resetting the lockout counter."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to attach the configuration onto."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityUniversalAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"clientId":{"type":"string"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"clientSecretTrustedIps":{},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"accessTokenPeriod":{"type":"number","default":0},"lockoutEnabled":{"type":"boolean","default":true},"lockoutThreshold":{"type":"number","default":3},"lockoutDurationSeconds":{"type":"number","default":300},"lockoutCounterResetSeconds":{"type":"number","default":30}},"required":["id","clientId","createdAt","updatedAt","identityId"],"additionalProperties":false}},"required":["identityUniversalAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateUniversalAuth","tags":["Universal Auth"],"description":"Update Universal Auth configuration on machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"clientSecretTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"description":"The new list of IPs or CIDR ranges that the Client Secret can be used from."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"description":"The new list of IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"description":"The new maximum number of times that an access token can be used."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new maximum lifetime for an access token in seconds."},"accessTokenPeriod":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new period for an access token in seconds."},"lockoutEnabled":{"type":"boolean","description":"Whether the lockout feature is enabled."},"lockoutThreshold":{"type":"number","minimum":1,"maximum":30,"description":"The amount of times login must fail before locking the identity auth method."},"lockoutDurationSeconds":{"type":"number","minimum":30,"maximum":86400,"description":"How long an identity auth method lockout lasts."},"lockoutCounterResetSeconds":{"type":"number","minimum":5,"maximum":3600,"description":"How long to wait from the most recent failed login until resetting the lockout counter."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityUniversalAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"clientId":{"type":"string"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"clientSecretTrustedIps":{},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"accessTokenPeriod":{"type":"number","default":0},"lockoutEnabled":{"type":"boolean","default":true},"lockoutThreshold":{"type":"number","default":3},"lockoutDurationSeconds":{"type":"number","default":300},"lockoutCounterResetSeconds":{"type":"number","default":30}},"required":["id","clientId","createdAt","updatedAt","identityId"],"additionalProperties":false}},"required":["identityUniversalAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getUniversalAuth","tags":["Universal Auth"],"description":"Retrieve Universal Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to retrieve the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityUniversalAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"clientId":{"type":"string"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"clientSecretTrustedIps":{},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"accessTokenPeriod":{"type":"number","default":0},"lockoutEnabled":{"type":"boolean","default":true},"lockoutThreshold":{"type":"number","default":3},"lockoutDurationSeconds":{"type":"number","default":300},"lockoutCounterResetSeconds":{"type":"number","default":30}},"required":["id","clientId","createdAt","updatedAt","identityId"],"additionalProperties":false}},"required":["identityUniversalAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteUniversalAuth","tags":["Universal Auth"],"description":"Delete Universal Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityUniversalAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"clientId":{"type":"string"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"clientSecretTrustedIps":{},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"accessTokenPeriod":{"type":"number","default":0},"lockoutEnabled":{"type":"boolean","default":true},"lockoutThreshold":{"type":"number","default":3},"lockoutDurationSeconds":{"type":"number","default":300},"lockoutCounterResetSeconds":{"type":"number","default":30}},"required":["id","clientId","createdAt","updatedAt","identityId"],"additionalProperties":false}},"required":["identityUniversalAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/universal-auth/identities/{identityId}/client-secrets":{"post":{"operationId":"createUniversalAuthClientSecret","tags":["Universal Auth"],"description":"Create Universal Auth Client Secret for machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","default":"","description":"The description of the client secret."},"numUsesLimit":{"type":"number","minimum":0,"default":0,"description":"The maximum number of times that the client secret can be used; a value of 0 implies infinite number of uses."},"ttl":{"type":"number","minimum":0,"maximum":315360000,"default":0,"description":"The lifetime for the client secret in seconds."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to create a client secret for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"clientSecret":{"type":"string"},"clientSecretData":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"description":{"type":"string"},"clientSecretPrefix":{"type":"string"},"clientSecretNumUses":{"type":"number","default":0},"clientSecretNumUsesLimit":{"type":"number","default":0},"clientSecretTTL":{"type":"number","default":0},"identityUAId":{"type":"string","format":"uuid"},"isClientSecretRevoked":{"type":"boolean","default":false}},"required":["id","createdAt","updatedAt","description","clientSecretPrefix","identityUAId"],"additionalProperties":false}},"required":["clientSecret","clientSecretData"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listUniversalAuthClientSecrets","tags":["Universal Auth"],"description":"List Universal Auth Client Secrets for machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to list client secrets for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"clientSecretData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"description":{"type":"string"},"clientSecretPrefix":{"type":"string"},"clientSecretNumUses":{"type":"number","default":0},"clientSecretNumUsesLimit":{"type":"number","default":0},"clientSecretTTL":{"type":"number","default":0},"identityUAId":{"type":"string","format":"uuid"},"isClientSecretRevoked":{"type":"boolean","default":false}},"required":["id","createdAt","updatedAt","description","clientSecretPrefix","identityUAId"],"additionalProperties":false}}},"required":["clientSecretData"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/universal-auth/identities/{identityId}/client-secrets/{clientSecretId}":{"get":{"operationId":"getUniversalAuthClientSecret","tags":["Universal Auth"],"description":"Get Universal Auth Client Secret for machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to get the client secret from."},{"schema":{"type":"string"},"in":"path","name":"clientSecretId","required":true,"description":"The ID of the client secret to get details."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"clientSecretData":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"description":{"type":"string"},"clientSecretPrefix":{"type":"string"},"clientSecretNumUses":{"type":"number","default":0},"clientSecretNumUsesLimit":{"type":"number","default":0},"clientSecretTTL":{"type":"number","default":0},"identityUAId":{"type":"string","format":"uuid"},"isClientSecretRevoked":{"type":"boolean","default":false}},"required":["id","createdAt","updatedAt","description","clientSecretPrefix","identityUAId"],"additionalProperties":false}},"required":["clientSecretData"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/universal-auth/identities/{identityId}/client-secrets/{clientSecretId}/revoke":{"post":{"operationId":"revokeUniversalAuthClientSecret","tags":["Universal Auth"],"description":"Revoke Universal Auth Client Secrets for machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the client secret from."},{"schema":{"type":"string"},"in":"path","name":"clientSecretId","required":true,"description":"The ID of the client secret to revoke."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"clientSecretData":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"description":{"type":"string"},"clientSecretPrefix":{"type":"string"},"clientSecretNumUses":{"type":"number","default":0},"clientSecretNumUsesLimit":{"type":"number","default":0},"clientSecretTTL":{"type":"number","default":0},"identityUAId":{"type":"string","format":"uuid"},"isClientSecretRevoked":{"type":"boolean","default":false}},"required":["id","createdAt","updatedAt","description","clientSecretPrefix","identityUAId"],"additionalProperties":false}},"required":["clientSecretData"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/universal-auth/identities/{identityId}/clear-lockouts":{"post":{"operationId":"clearUniversalAuthLockouts","tags":["Universal Auth"],"description":"Clear Universal Auth Lockouts for machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to clear the client lockouts from."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"number"}},"required":["deleted"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/kubernetes-auth/login":{"post":{"operationId":"loginWithKubernetesAuth","tags":["Kubernetes Auth"],"description":"Login with Kubernetes Auth for machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","description":"The ID of the machine identity to login."},"jwt":{"type":"string"},"organizationSlug":{"type":"string","minLength":1,"maxLength":64,"description":"When set, this will scope the login session to the specified organization the machine identity has access to. If omitted, the session defaults to the organization where the machine identity was created in."}},"required":["identityId","jwt"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/kubernetes-auth/identities/{identityId}":{"post":{"operationId":"attachKubernetesAuth","tags":["Kubernetes Auth"],"description":"Attach Kubernetes Auth configuration onto machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"templateId":{"type":"string","format":"uuid","description":"The ID of the Kubernetes auth template to source connection settings from. When provided, the host, CA certificate, token reviewer JWT, token review mode, gateway, and allowed audience are taken from the template and cannot be set individually."},"kubernetesHost":{"type":"string","minLength":1,"maxLength":255,"nullable":true,"description":"The host string, host:port pair, or URL to the base of the Kubernetes API server."},"caCert":{"type":"string","description":"The PEM-encoded CA certificate used to validate the Kubernetes API server's TLS certificate. Required when verifyTlsCertificate is true. Supplying a non-empty caCert always implies verifyTlsCertificate=true; explicitly setting the toggle to false in the same request is rejected."},"verifyTlsCertificate":{"type":"boolean","description":"Whether to verify the Kubernetes API server's TLS certificate against the configured CA certificate. When true, caCert is required. When false, the connection is still over HTTPS but the API server's certificate is not verified, and caCert must be empty. If omitted, defaults to true when caCert is provided and false otherwise."},"tokenReviewerJwt":{"type":"string","description":"Optional JWT token for accessing Kubernetes TokenReview API. If provided, this long-lived token will be used to validate service account tokens during authentication. If omitted, the client's own JWT will be used instead, which requires the client to have the system:auth-delegator ClusterRole binding."},"tokenReviewMode":{"type":"string","enum":["api","gateway"],"description":"The mode to use for token review. Must be one of: 'api', 'gateway'. Defaults to 'api' when omitted. If gateway is selected, the gateway must be deployed in Kubernetes, and the gateway must have the system:auth-delegator ClusterRole binding."},"allowedNamespaces":{"type":"string","description":"The comma-separated list of trusted namespaces that service accounts must belong to authenticate with Infisical."},"allowedNames":{"type":"string","description":"The comma-separated list of trusted service account names that can authenticate with Infisical."},"allowedAudience":{"type":"string","maxLength":1000,"description":"The optional audience claim that the service account JWT token must have to authenticate with Infisical."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway to use when performing kubernetes API requests."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."}},"required":["allowedNamespaces","allowedNames"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to attach the configuration onto."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityKubernetesAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"tokenReviewMode":{"type":"string","default":"api"},"identityId":{"type":"string","format":"uuid"},"kubernetesHost":{"type":"string","nullable":true},"allowedNamespaces":{"type":"string"},"allowedNames":{"type":"string"},"allowedAudience":{"type":"string"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"verifyTlsCertificate":{"type":"boolean","default":false},"templateId":{"type":"string","format":"uuid","nullable":true},"isTokenReviewerJwtTemplateSourced":{"type":"boolean","default":false},"caCert":{"type":"string"},"tokenReviewerJwt":{"type":"string","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true}},"required":["id","createdAt","updatedAt","identityId","allowedNamespaces","allowedNames","allowedAudience","caCert"],"additionalProperties":false}},"required":["identityKubernetesAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateKubernetesAuth","tags":["Kubernetes Auth"],"description":"Update Kubernetes Auth configuration on machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"templateId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the Kubernetes auth template to link. While linked, connection settings are managed by the template and cannot be set individually. Pass null to unlink the template; the settings copied from it are kept."},"kubernetesHost":{"type":"string","minLength":1,"maxLength":255,"nullable":true,"description":"The new host string, host:port pair, or URL to the base of the Kubernetes API server."},"caCert":{"type":"string","description":"The new PEM-encoded CA certificate used to validate the Kubernetes API server's TLS certificate. Required when verifyTlsCertificate is true. Supplying a non-empty caCert always implies verifyTlsCertificate=true; the update is rejected if the resulting effective state would store a CA together with verifyTlsCertificate=false."},"verifyTlsCertificate":{"type":"boolean","description":"Whether to verify the Kubernetes API server's TLS certificate against the configured CA certificate. When true, caCert is required. When false, the connection is still over HTTPS but the API server's certificate is not verified, and the resulting effective CA must be empty. If omitted while supplying a non-empty caCert in the same update, the toggle is auto-promoted to true; otherwise the stored value is preserved."},"tokenReviewerJwt":{"type":"string","nullable":true,"description":"Optional JWT token for accessing Kubernetes TokenReview API. If provided, this long-lived token will be used to validate service account tokens during authentication. If omitted, the client's own JWT will be used instead, which requires the client to have the system:auth-delegator ClusterRole binding."},"tokenReviewMode":{"type":"string","enum":["api","gateway"],"description":"The mode to use for token review. Must be one of: 'api', 'gateway'. If gateway is selected, the gateway must be deployed in Kubernetes, and the gateway must have the system:auth-delegator ClusterRole binding."},"allowedNamespaces":{"type":"string","description":"The new comma-separated list of trusted namespaces that service accounts must belong to authenticate with Infisical."},"allowedNames":{"type":"string","description":"The new comma-separated list of trusted service account names that can authenticate with Infisical."},"allowedAudience":{"type":"string","maxLength":1000,"description":"The new optional audience claim that the service account JWT token must have to authenticate with Infisical."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the gateway to use when performing kubernetes API requests."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"description":"The new IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new lifetime for an acccess token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"description":"The new maximum number of times that an access token can be used."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new maximum lifetime for an acccess token in seconds."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityKubernetesAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"tokenReviewMode":{"type":"string","default":"api"},"identityId":{"type":"string","format":"uuid"},"kubernetesHost":{"type":"string","nullable":true},"allowedNamespaces":{"type":"string"},"allowedNames":{"type":"string"},"allowedAudience":{"type":"string"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"verifyTlsCertificate":{"type":"boolean","default":false},"templateId":{"type":"string","format":"uuid","nullable":true},"isTokenReviewerJwtTemplateSourced":{"type":"boolean","default":false},"caCert":{"type":"string"},"tokenReviewerJwt":{"type":"string","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true}},"required":["id","createdAt","updatedAt","identityId","allowedNamespaces","allowedNames","allowedAudience","caCert"],"additionalProperties":false}},"required":["identityKubernetesAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getKubernetesAuth","tags":["Kubernetes Auth"],"description":"Retrieve Kubernetes Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to retrieve the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityKubernetesAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"tokenReviewMode":{"type":"string","default":"api"},"identityId":{"type":"string","format":"uuid"},"kubernetesHost":{"type":"string","nullable":true},"allowedNamespaces":{"type":"string"},"allowedNames":{"type":"string"},"allowedAudience":{"type":"string"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"verifyTlsCertificate":{"type":"boolean","default":false},"templateId":{"type":"string","format":"uuid","nullable":true},"isTokenReviewerJwtTemplateSourced":{"type":"boolean","default":false},"caCert":{"type":"string"},"tokenReviewerJwt":{"type":"string","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true}},"required":["id","createdAt","updatedAt","identityId","allowedNamespaces","allowedNames","allowedAudience","caCert"],"additionalProperties":false}},"required":["identityKubernetesAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteKubernetesAuth","tags":["Kubernetes Auth"],"description":"Delete Kubernetes Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityKubernetesAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"tokenReviewMode":{"type":"string","default":"api"},"identityId":{"type":"string","format":"uuid"},"kubernetesHost":{"type":"string","nullable":true},"allowedNamespaces":{"type":"string"},"allowedNames":{"type":"string"},"allowedAudience":{"type":"string"},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"verifyTlsCertificate":{"type":"boolean","default":false},"templateId":{"type":"string","format":"uuid","nullable":true},"isTokenReviewerJwtTemplateSourced":{"type":"boolean","default":false},"gatewayId":{"type":"string","format":"uuid","nullable":true}},"required":["id","createdAt","updatedAt","identityId","allowedNamespaces","allowedNames","allowedAudience"],"additionalProperties":false}},"required":["identityKubernetesAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/gcp-auth/login":{"post":{"operationId":"loginWithGcpAuth","tags":["GCP Auth"],"description":"Login with GCP Auth for machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","description":"The ID of the machine identity to login."},"jwt":{"type":"string"},"organizationSlug":{"type":"string","minLength":1,"maxLength":64,"description":"When set, this will scope the login session to the specified organization the machine identity has access to. If omitted, the session defaults to the organization where the machine identity was created in."}},"required":["identityId","jwt"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/gcp-auth/identities/{identityId}":{"post":{"operationId":"attachGcpAuth","tags":["GCP Auth"],"description":"Attach GCP Auth configuration onto machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["iam","gce"]},"allowedServiceAccounts":{"type":"string","default":"","description":"The comma-separated list of trusted service account emails corresponding to the GCE resource(s) allowed to authenticate with Infisical."},"allowedProjects":{"type":"string","default":"","description":"The comma-separated list of trusted GCP projects that the GCE instance must belong to authenticate with Infisical."},"allowedZones":{"type":"string","default":"","description":"The comma-separated list of trusted zones that the GCE instances must belong to authenticate with Infisical."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."}},"required":["type"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to attach the configuration onto."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityGcpAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"allowedServiceAccounts":{"type":"string","nullable":true},"allowedProjects":{"type":"string","nullable":true},"allowedZones":{"type":"string","nullable":true},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","type"],"additionalProperties":false}},"required":["identityGcpAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateGcpAuth","tags":["GCP Auth"],"description":"Update GCP Auth configuration on machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["iam","gce"]},"allowedServiceAccounts":{"type":"string","default":"","description":"The new comma-separated list of trusted service account emails corresponding to the GCE resource(s) allowed to authenticate with Infisical."},"allowedProjects":{"type":"string","default":"","description":"The new comma-separated list of trusted GCP projects that the GCE instance must belong to authenticate with Infisical."},"allowedZones":{"type":"string","default":"","description":"The new comma-separated list of trusted zones that the GCE instances must belong to authenticate with Infisical."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"description":"The new IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"description":"The new maximum number of times that an access token can be used."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new maximum lifetime for an access token in seconds."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityGcpAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"allowedServiceAccounts":{"type":"string","nullable":true},"allowedProjects":{"type":"string","nullable":true},"allowedZones":{"type":"string","nullable":true},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","type"],"additionalProperties":false}},"required":["identityGcpAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getGcpAuth","tags":["GCP Auth"],"description":"Retrieve GCP Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to retrieve the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityGcpAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"allowedServiceAccounts":{"type":"string","nullable":true},"allowedProjects":{"type":"string","nullable":true},"allowedZones":{"type":"string","nullable":true},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","type"],"additionalProperties":false}},"required":["identityGcpAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteGcpAuth","tags":["GCP Auth"],"description":"Delete GCP Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityGcpAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"allowedServiceAccounts":{"type":"string","nullable":true},"allowedProjects":{"type":"string","nullable":true},"allowedZones":{"type":"string","nullable":true},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","type"],"additionalProperties":false}},"required":["identityGcpAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/token/renew":{"post":{"operationId":"renewIdentityAccessToken","tags":["Universal Auth"],"description":"Renew machine identity access token","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token to renew."}},"required":["accessToken"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/token/revoke":{"post":{"operationId":"revokeIdentityAccessToken","tags":["Universal Auth"],"description":"Revoke machine identity access token","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string","description":"The access token to revoke."}},"required":["accessToken"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/alicloud-auth/login":{"post":{"operationId":"loginWithAlicloudAuth","tags":["Alibaba Cloud Auth"],"description":"Login with Alibaba Cloud Auth for machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","description":"The ID of the machine identity to login."},"Action":{"type":"string","enum":["GetCallerIdentity"],"description":"The Alibaba Cloud API action. For STS GetCallerIdentity, this should be 'GetCallerIdentity'."},"Format":{"type":"string","enum":["JSON"],"description":"The response format. For STS GetCallerIdentity, this should be 'JSON'."},"Version":{"type":"string","description":"The API version. This should be in 'YYYY-MM-DD' format (e.g., '2015-04-01')."},"AccessKeyId":{"type":"string","description":"The AccessKey ID of the RAM user or STS token."},"organizationSlug":{"type":"string","minLength":1,"maxLength":64,"description":"When set, this will scope the login session to the specified organization the machine identity has access to. If omitted, the session defaults to the organization where the machine identity was created in."},"SignatureMethod":{"type":"string","enum":["HMAC-SHA1"],"description":"The signature algorithm. For STS GetCallerIdentity, this should be 'HMAC-SHA1'."},"Timestamp":{"type":"string","format":"date-time","description":"The timestamp of the request in UTC, formatted as 'YYYY-MM-DDTHH:mm:ssZ'."},"SignatureVersion":{"type":"string","enum":["1.0"],"description":"The signature version. For STS GetCallerIdentity, this should be '1.0'."},"SignatureNonce":{"type":"string","description":"A unique random string to prevent replay attacks."},"Signature":{"type":"string","description":"The signature string calculated based on the request parameters and AccessKey Secret."}},"required":["identityId","Action","Format","Version","AccessKeyId","SignatureMethod","Timestamp","SignatureVersion","SignatureNonce","Signature"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/alicloud-auth/identities/{identityId}":{"post":{"operationId":"attachAlicloudAuth","tags":["Alibaba Cloud Auth"],"description":"Attach Alibaba Cloud Auth configuration onto machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"allowedArns":{"type":"string","minLength":1,"maxLength":500,"description":"The comma-separated list of trusted ARNs that are allowed to authenticate with Infisical."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":1,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."}},"required":["allowedArns"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to attach the configuration onto."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityAliCloudAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"allowedArns":{"type":"string"}},"required":["id","createdAt","updatedAt","identityId","type","allowedArns"],"additionalProperties":false}},"required":["identityAliCloudAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAlicloudAuth","tags":["Alibaba Cloud Auth"],"description":"Update Alibaba Cloud Auth configuration on machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"allowedArns":{"type":"string","minLength":1,"maxLength":500,"description":"The comma-separated list of trusted ARNs that are allowed to authenticate with Infisical."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"description":"The new IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"description":"The new maximum number of times that an access token can be used."},"accessTokenMaxTTL":{"type":"integer","maximum":315360000,"minimum":0,"description":"The new maximum lifetime for an access token in seconds."}},"required":["allowedArns"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityAliCloudAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"allowedArns":{"type":"string"}},"required":["id","createdAt","updatedAt","identityId","type","allowedArns"],"additionalProperties":false}},"required":["identityAliCloudAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getAlicloudAuth","tags":["Alibaba Cloud Auth"],"description":"Retrieve Alibaba Cloud Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to retrieve the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityAliCloudAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"allowedArns":{"type":"string"}},"required":["id","createdAt","updatedAt","identityId","type","allowedArns"],"additionalProperties":false}},"required":["identityAliCloudAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAlicloudAuth","tags":["Alibaba Cloud Auth"],"description":"Delete Alibaba Cloud Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityAliCloudAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"allowedArns":{"type":"string"}},"required":["id","createdAt","updatedAt","identityId","type","allowedArns"],"additionalProperties":false}},"required":["identityAliCloudAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/aws-auth/login":{"post":{"operationId":"loginWithAwsAuth","tags":["AWS Auth"],"description":"Login with AWS Auth for machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","description":"The ID of the machine identity to login."},"iamHttpRequestMethod":{"type":"string","default":"POST","description":"The HTTP request method used in the signed request."},"iamRequestBody":{"type":"string","description":"The base64-encoded body of the signed request. Most likely, the base64-encoding of Action=GetCallerIdentity&Version=2011-06-15."},"iamRequestHeaders":{"type":"string","description":"The base64-encoded headers of the sts:GetCallerIdentity signed request."},"organizationSlug":{"type":"string","minLength":1,"maxLength":64,"description":"When set, this will scope the login session to the specified organization the machine identity has access to. If omitted, the session defaults to the organization where the machine identity was created in."}},"required":["identityId","iamRequestBody","iamRequestHeaders"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/aws-auth/identities/{identityId}":{"post":{"operationId":"attachAwsAuth","tags":["AWS Auth"],"description":"Attach AWS Auth configuration onto machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stsEndpoint":{"type":"string","minLength":1,"default":"https://sts.amazonaws.com/","description":"The endpoint URL for the AWS STS API."},"allowedPrincipalArns":{"type":"string","maxLength":4096,"default":"","description":"The comma-separated list of trusted IAM principal ARNs that are allowed to authenticate with Infisical."},"allowedAccountIds":{"type":"string","maxLength":4096,"default":"","description":"The comma-separated list of trusted AWS account IDs that are allowed to authenticate with Infisical."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":1,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to attach the configuration onto."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityAwsAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"stsEndpoint":{"type":"string"},"allowedPrincipalArns":{"type":"string"},"allowedAccountIds":{"type":"string"},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","type","stsEndpoint","allowedPrincipalArns","allowedAccountIds"],"additionalProperties":false}},"required":["identityAwsAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAwsAuth","tags":["AWS Auth"],"description":"Update AWS Auth configuration on machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stsEndpoint":{"type":"string","minLength":1,"description":"The new endpoint URL for the AWS STS API."},"allowedPrincipalArns":{"type":"string","maxLength":4096,"default":"","description":"The new comma-separated list of trusted IAM principal ARNs that are allowed to authenticate with Infisical."},"allowedAccountIds":{"type":"string","maxLength":4096,"default":"","description":"The new comma-separated list of trusted AWS account IDs that are allowed to authenticate with Infisical."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"description":"The new IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"description":"The new maximum number of times that an access token can be used."},"accessTokenMaxTTL":{"type":"integer","maximum":315360000,"minimum":0,"description":"The new maximum lifetime for an access token in seconds."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityAwsAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"stsEndpoint":{"type":"string"},"allowedPrincipalArns":{"type":"string"},"allowedAccountIds":{"type":"string"},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","type","stsEndpoint","allowedPrincipalArns","allowedAccountIds"],"additionalProperties":false}},"required":["identityAwsAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getAwsAuth","tags":["AWS Auth"],"description":"Retrieve AWS Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to retrieve the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityAwsAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"stsEndpoint":{"type":"string"},"allowedPrincipalArns":{"type":"string"},"allowedAccountIds":{"type":"string"},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","type","stsEndpoint","allowedPrincipalArns","allowedAccountIds"],"additionalProperties":false}},"required":["identityAwsAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAwsAuth","tags":["AWS Auth"],"description":"Delete AWS Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityAwsAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"stsEndpoint":{"type":"string"},"allowedPrincipalArns":{"type":"string"},"allowedAccountIds":{"type":"string"},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","type","stsEndpoint","allowedPrincipalArns","allowedAccountIds"],"additionalProperties":false}},"required":["identityAwsAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/tls-cert-auth/login":{"post":{"operationId":"loginWithTlsCertAuth","tags":["TLS Certificate Auth"],"description":"Login with TLS Certificate Auth for machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","description":"The ID of the machine identity to login."},"organizationSlug":{"type":"string","minLength":1,"maxLength":64,"description":"When set, this will scope the login session to the specified organization the machine identity has access to. If omitted, the session defaults to the organization where the machine identity was created in."}},"required":["identityId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/tls-cert-auth/identities/{identityId}":{"post":{"operationId":"attachTlsCertAuth","tags":["TLS Certificate Auth"],"description":"Attach TLS Certificate Auth configuration onto machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"allowedCommonNames":{"type":"string","minLength":1,"nullable":true,"description":"The comma-separated list of trusted common names that are allowed to authenticate with Infisical."},"allowedSubjectAltNames":{"type":"array","items":{"type":"string","minLength":1},"nullable":true,"description":"The comma-separated list of trusted subject alternative names that are allowed to authenticate with Infisical. Prefix entries by type (URI:, DNS:, IP:, EMAIL:). Bare entries are treated as DNS names."},"caCertificate":{"type":"string","minLength":1,"maxLength":10240,"description":"The PEM-encoded CA certificate to validate client certificates."},"verifyClientCertificateChain":{"type":"boolean","default":false,"description":"When false (default), the CA certificate must be the direct issuer of the client's leaf certificate. When true, the CA certificate is treated as a trust anchor and the client-presented chain (leaf plus intermediates) is validated up to it, supporting issuers that rotate beneath a stable root such as SPIRE X.509-SVIDs."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":1,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."}},"required":["caCertificate"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to attach the configuration onto."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityTlsCertAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"allowedCommonNames":{"type":"string","nullable":true},"encryptedCaCertificate":{},"allowedSubjectAltNames":{"type":"array","items":{"type":"string"},"nullable":true},"verifyClientCertificateChain":{"type":"boolean","default":false}},"required":["id","createdAt","updatedAt","identityId","encryptedCaCertificate","allowedSubjectAltNames"],"additionalProperties":false}},"required":["identityTlsCertAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateTlsCertAuth","tags":["TLS Certificate Auth"],"description":"Update TLS Certificate Auth configuration on machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caCertificate":{"type":"string","minLength":1,"maxLength":10240,"description":"The PEM-encoded CA certificate to validate client certificates."},"verifyClientCertificateChain":{"type":"boolean","description":"When false (default), the CA certificate must be the direct issuer of the client's leaf certificate. When true, the CA certificate is treated as a trust anchor and the client-presented chain (leaf plus intermediates) is validated up to it, supporting issuers that rotate beneath a stable root such as SPIRE X.509-SVIDs."},"allowedCommonNames":{"type":"string","minLength":1,"nullable":true,"description":"The comma-separated list of trusted common names that are allowed to authenticate with Infisical."},"allowedSubjectAltNames":{"type":"array","items":{"type":"string","minLength":1},"nullable":true,"description":"The comma-separated list of trusted subject alternative names that are allowed to authenticate with Infisical. Prefix entries by type (URI:, DNS:, IP:, EMAIL:). Bare entries are treated as DNS names."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"description":"The new IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"description":"The new maximum number of times that an access token can be used."},"accessTokenMaxTTL":{"type":"integer","maximum":315360000,"minimum":0,"description":"The new maximum lifetime for an access token in seconds."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityTlsCertAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"allowedCommonNames":{"type":"string","nullable":true},"encryptedCaCertificate":{},"allowedSubjectAltNames":{"type":"array","items":{"type":"string"},"nullable":true},"verifyClientCertificateChain":{"type":"boolean","default":false}},"required":["id","createdAt","updatedAt","identityId","encryptedCaCertificate","allowedSubjectAltNames"],"additionalProperties":false}},"required":["identityTlsCertAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getTlsCertAuth","tags":["TLS Certificate Auth"],"description":"Retrieve TLS Certificate Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to retrieve the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityTlsCertAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"allowedCommonNames":{"type":"string","nullable":true},"encryptedCaCertificate":{},"allowedSubjectAltNames":{"type":"array","items":{"type":"string"},"nullable":true},"verifyClientCertificateChain":{"type":"boolean","default":false},"caCertificate":{"type":"string"}},"required":["id","createdAt","updatedAt","identityId","encryptedCaCertificate","allowedSubjectAltNames","caCertificate"],"additionalProperties":false}},"required":["identityTlsCertAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteTlsCertAuth","tags":["TLS Certificate Auth"],"description":"Delete TLS Certificate Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityTlsCertAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"allowedCommonNames":{"type":"string","nullable":true},"encryptedCaCertificate":{},"allowedSubjectAltNames":{"type":"array","items":{"type":"string"},"nullable":true},"verifyClientCertificateChain":{"type":"boolean","default":false}},"required":["id","createdAt","updatedAt","identityId","encryptedCaCertificate","allowedSubjectAltNames"],"additionalProperties":false}},"required":["identityTlsCertAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/azure-auth/login":{"post":{"operationId":"loginWithAzureAuth","tags":["Azure Auth"],"description":"Login with Azure Auth for machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","description":"The ID of the machine identity to login."},"jwt":{"type":"string"},"organizationSlug":{"type":"string","minLength":1,"maxLength":64,"description":"When set, this will scope the login session to the specified organization the machine identity has access to. If omitted, the session defaults to the organization where the machine identity was created in."}},"required":["identityId","jwt"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/azure-auth/identities/{identityId}":{"post":{"operationId":"attachAzureAuth","tags":["Azure Auth"],"description":"Attach Azure Auth configuration onto machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant ID for the Azure AD organization."},"resource":{"type":"string","description":"The resource URL for the application registered in Azure AD."},"allowedServicePrincipalIds":{"type":"string","default":"","description":"The comma-separated list of Azure AD service principal IDs that are allowed to authenticate with Infisical."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."}},"required":["tenantId","resource"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to login."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityAzureAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"tenantId":{"type":"string"},"resource":{"type":"string"},"allowedServicePrincipalIds":{"type":"string"},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","tenantId","resource","allowedServicePrincipalIds"],"additionalProperties":false}},"required":["identityAzureAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAzureAuth","tags":["Azure Auth"],"description":"Update Azure Auth configuration on machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tenantId":{"type":"string","description":"The new tenant ID for the Azure AD organization."},"resource":{"type":"string","description":"The new resource URL for the application registered in Azure AD."},"allowedServicePrincipalIds":{"type":"string","default":"","description":"The new comma-separated list of Azure AD service principal IDs that are allowed to authenticate with Infisical."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"description":"The new IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"description":"The new maximum number of times that an access token can be used."},"accessTokenMaxTTL":{"type":"integer","maximum":315360000,"minimum":0,"description":"The new maximum lifetime for an access token in seconds."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityAzureAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"tenantId":{"type":"string"},"resource":{"type":"string"},"allowedServicePrincipalIds":{"type":"string"},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","tenantId","resource","allowedServicePrincipalIds"],"additionalProperties":false}},"required":["identityAzureAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getAzureAuth","tags":["Azure Auth"],"description":"Retrieve Azure Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to retrieve the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityAzureAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"tenantId":{"type":"string"},"resource":{"type":"string"},"allowedServicePrincipalIds":{"type":"string"},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","tenantId","resource","allowedServicePrincipalIds"],"additionalProperties":false}},"required":["identityAzureAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAzureAuth","tags":["Azure Auth"],"description":"Delete Azure Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityAzureAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"tenantId":{"type":"string"},"resource":{"type":"string"},"allowedServicePrincipalIds":{"type":"string"},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","tenantId","resource","allowedServicePrincipalIds"],"additionalProperties":false}},"required":["identityAzureAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/oci-auth/login":{"post":{"operationId":"loginWithOciAuth","tags":["OCI Auth"],"description":"Login with OCI Auth for machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","description":"The ID of the machine identity to login."},"userOcid":{"type":"string","description":"The OCID of the user attempting login."},"headers":{"type":"object","properties":{"authorization":{"type":"string"},"host":{"type":"string"},"x-date":{"type":"string"},"date":{"type":"string"}},"required":["authorization","host"],"additionalProperties":false,"description":"The headers of the signed request."},"organizationSlug":{"type":"string","minLength":1,"maxLength":64,"description":"When set, this will scope the login session to the specified organization the machine identity has access to. If omitted, the session defaults to the organization where the machine identity was created in."}},"required":["identityId","userOcid","headers"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/oci-auth/identities/{identityId}":{"post":{"operationId":"attachOciAuth","tags":["OCI Auth"],"description":"Attach OCI Auth configuration onto machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tenancyOcid":{"type":"string","minLength":1,"description":"The OCID of your tenancy."},"allowedUsernames":{"type":"string","maxLength":500,"nullable":true,"description":"The comma-separated list of trusted OCI account usernames that are allowed to authenticate with Infisical."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":1,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."}},"required":["tenancyOcid"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to attach the configuration onto."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityOciAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"tenancyOcid":{"type":"string"},"allowedUsernames":{"type":"string","nullable":true},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","type","tenancyOcid"],"additionalProperties":false}},"required":["identityOciAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateOciAuth","tags":["OCI Auth"],"description":"Update OCI Auth configuration on machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tenancyOcid":{"type":"string","minLength":1,"description":"The OCID of your tenancy."},"allowedUsernames":{"type":"string","maxLength":500,"nullable":true,"description":"The comma-separated list of trusted OCI account usernames that are allowed to authenticate with Infisical."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"description":"The new IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"description":"The new maximum number of times that an access token can be used."},"accessTokenMaxTTL":{"type":"integer","maximum":315360000,"minimum":0,"description":"The new maximum lifetime for an access token in seconds."}},"required":["tenancyOcid"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityOciAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"tenancyOcid":{"type":"string"},"allowedUsernames":{"type":"string","nullable":true},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","type","tenancyOcid"],"additionalProperties":false}},"required":["identityOciAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getOciAuth","tags":["OCI Auth"],"description":"Retrieve OCI Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to retrieve the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityOciAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"tenancyOcid":{"type":"string"},"allowedUsernames":{"type":"string","nullable":true},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","type","tenancyOcid"],"additionalProperties":false}},"required":["identityOciAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteOciAuth","tags":["OCI Auth"],"description":"Delete OCI Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityOciAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"type":{"type":"string"},"tenancyOcid":{"type":"string"},"allowedUsernames":{"type":"string","nullable":true},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","createdAt","updatedAt","identityId","type","tenancyOcid"],"additionalProperties":false}},"required":["identityOciAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/oidc-auth/login":{"post":{"operationId":"loginWithOidcAuth","tags":["OIDC Auth"],"description":"Login with OIDC Auth for machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","description":"The ID of the machine identity to login."},"jwt":{"type":"string"},"organizationSlug":{"type":"string","minLength":1,"maxLength":64,"description":"When set, this will scope the login session to the specified organization the machine identity has access to. If omitted, the session defaults to the organization where the machine identity was created in."}},"required":["identityId","jwt"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/oidc-auth/identities/{identityId}":{"post":{"operationId":"attachOidcAuth","tags":["OIDC Auth"],"description":"Attach OIDC Auth configuration onto machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"templateId":{"type":"string","format":"uuid","description":"The ID of the OIDC auth template to source identity provider settings from. When provided, the OIDC discovery URL, issuer, audiences, and CA certificate are taken from the template and cannot be set individually."},"oidcDiscoveryUrl":{"type":"string","format":"uri","minLength":1,"description":"The URL used to retrieve the OpenID Connect configuration from the identity provider."},"caCert":{"type":"string","description":"The PEM-encoded CA cert for establishing secure communication with the Identity Provider endpoints."},"boundIssuer":{"type":"string","minLength":1,"description":"The unique identifier of the identity provider issuing the JWT."},"boundAudiences":{"type":"string","description":"The list of intended recipients."},"boundClaims":{"type":"object","additionalProperties":{"type":"string"},"description":"The attributes that should be present in the JWT for it to be valid."},"claimMetadataMapping":{"type":"object","additionalProperties":{"type":"string"},"description":"The attributes that should be present in the permission metadata from the JWT."},"boundSubject":{"type":"string","default":"","description":"The expected principal that is the subject of the JWT."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."}},"required":["boundClaims"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to attach the configuration onto."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityOidcAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"identityId":{"type":"string","format":"uuid"},"oidcDiscoveryUrl":{"type":"string"},"boundIssuer":{"type":"string"},"boundAudiences":{"type":"string"},"boundClaims":{},"claimMetadataMapping":{"nullable":true},"boundSubject":{"type":"string","nullable":true},"templateId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caCert":{"type":"string"}},"required":["id","identityId","oidcDiscoveryUrl","boundIssuer","boundAudiences","createdAt","updatedAt","caCert"],"additionalProperties":false}},"required":["identityOidcAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateOidcAuth","tags":["OIDC Auth"],"description":"Update OIDC Auth configuration on machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"oidcDiscoveryUrl":{"type":"string","format":"uri","minLength":1,"description":"The new URL used to retrieve the OpenID Connect configuration from the identity provider."},"caCert":{"type":"string","default":"","description":"The new PEM-encoded CA cert for establishing secure communication with the Identity Provider endpoints."},"boundIssuer":{"type":"string","minLength":1,"description":"The new unique identifier of the identity provider issuing the JWT."},"boundAudiences":{"type":"string","default":"","description":"The new list of intended recipients."},"boundClaims":{"type":"object","additionalProperties":{"type":"string"},"description":"The new attributes that should be present in the JWT for it to be valid."},"claimMetadataMapping":{"type":"object","additionalProperties":{"type":"string"},"description":"The new attributes that should be present in the permission metadata from the JWT."},"boundSubject":{"type":"string","default":"","description":"The new expected principal that is the subject of the JWT."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The new IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The new lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The new maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The new maximum number of times that an access token can be used."},"templateId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the OIDC auth template to link. While linked, identity provider settings are managed by the template and cannot be set individually. Pass null to unlink the template; the settings copied from it are kept."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityOidcAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"identityId":{"type":"string","format":"uuid"},"oidcDiscoveryUrl":{"type":"string"},"boundIssuer":{"type":"string"},"boundAudiences":{"type":"string"},"boundClaims":{},"claimMetadataMapping":{"nullable":true},"boundSubject":{"type":"string","nullable":true},"templateId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caCert":{"type":"string"}},"required":["id","identityId","oidcDiscoveryUrl","boundIssuer","boundAudiences","createdAt","updatedAt","caCert"],"additionalProperties":false}},"required":["identityOidcAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getOidcAuth","tags":["OIDC Auth"],"description":"Retrieve OIDC Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to retrieve the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityOidcAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"identityId":{"type":"string","format":"uuid"},"oidcDiscoveryUrl":{"type":"string"},"boundIssuer":{"type":"string"},"boundAudiences":{"type":"string"},"boundClaims":{},"claimMetadataMapping":{"nullable":true},"boundSubject":{"type":"string","nullable":true},"templateId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caCert":{"type":"string"}},"required":["id","identityId","oidcDiscoveryUrl","boundIssuer","boundAudiences","createdAt","updatedAt","caCert"],"additionalProperties":false}},"required":["identityOidcAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteOidcAuth","tags":["OIDC Auth"],"description":"Delete OIDC Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityOidcAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"identityId":{"type":"string","format":"uuid"},"oidcDiscoveryUrl":{"type":"string"},"boundIssuer":{"type":"string"},"boundAudiences":{"type":"string"},"boundClaims":{},"claimMetadataMapping":{"nullable":true},"boundSubject":{"type":"string","nullable":true},"templateId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","identityId","oidcDiscoveryUrl","boundIssuer","boundAudiences","createdAt","updatedAt"],"additionalProperties":false}},"required":["identityOidcAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/jwt-auth/login":{"post":{"operationId":"loginWithJwtAuth","tags":["JWT Auth"],"description":"Login with JWT Auth for machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","description":"The ID of the machine identity to login."},"jwt":{"type":"string"},"organizationSlug":{"type":"string","minLength":1,"maxLength":64,"description":"When set, this will scope the login session to the specified organization the machine identity has access to. If omitted, the session defaults to the organization where the machine identity was created in."}},"required":["identityId","jwt"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/jwt-auth/identities/{identityId}":{"post":{"operationId":"attachJwtAuth","tags":["JWT Auth"],"description":"Attach JWT Auth configuration onto machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"configurationType":{"type":"string","enum":["jwks"],"description":"The configuration for validating JWTs. Must be one of: 'jwks', 'static'"},"jwksUrl":{"type":"string","format":"uri","description":"The URL of the JWKS endpoint. Required if configurationType is 'jwks'. This endpoint must serve JSON Web Key Sets (JWKS) containing the public keys used to verify JWT signatures."},"jwksCaCert":{"type":"string","default":"","description":"The PEM-encoded CA certificate for validating the TLS connection to the JWKS endpoint."},"publicKeys":{"type":"array","items":{"type":"string"},"default":[],"description":"A list of PEM-encoded public keys used to verify JWT signatures. Required if configurationType is 'static'. Each key must be in RSA or ECDSA format and properly PEM-encoded with BEGIN/END markers."},"boundIssuer":{"type":"string","default":"","description":"The unique identifier of the JWT provider."},"boundAudiences":{"type":"string","default":"","description":"The list of intended recipients."},"boundClaims":{"type":"object","additionalProperties":{"type":"string"},"description":"The attributes that should be present in the JWT for it to be valid."},"boundSubject":{"type":"string","default":"","description":"The expected principal that is the subject of the JWT."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."}},"required":["configurationType","jwksUrl","boundClaims"],"additionalProperties":false},{"type":"object","properties":{"configurationType":{"type":"string","enum":["static"],"description":"The configuration for validating JWTs. Must be one of: 'jwks', 'static'"},"jwksUrl":{"type":"string","default":"","description":"The URL of the JWKS endpoint. Required if configurationType is 'jwks'. This endpoint must serve JSON Web Key Sets (JWKS) containing the public keys used to verify JWT signatures."},"jwksCaCert":{"type":"string","default":"","description":"The PEM-encoded CA certificate for validating the TLS connection to the JWKS endpoint."},"publicKeys":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"description":"A list of PEM-encoded public keys used to verify JWT signatures. Required if configurationType is 'static'. Each key must be in RSA or ECDSA format and properly PEM-encoded with BEGIN/END markers."},"boundIssuer":{"type":"string","default":"","description":"The unique identifier of the JWT provider."},"boundAudiences":{"type":"string","default":"","description":"The list of intended recipients."},"boundClaims":{"type":"object","additionalProperties":{"type":"string"},"description":"The attributes that should be present in the JWT for it to be valid."},"boundSubject":{"type":"string","default":"","description":"The expected principal that is the subject of the JWT."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."}},"required":["configurationType","publicKeys","boundClaims"],"additionalProperties":false}]}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to attach the configuration onto."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityJwtAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"identityId":{"type":"string","format":"uuid"},"configurationType":{"type":"string"},"jwksUrl":{"type":"string"},"boundIssuer":{"type":"string"},"boundAudiences":{"type":"string"},"boundClaims":{},"boundSubject":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"accessTokenPeriod":{"type":"number","default":0},"jwksCaCert":{"type":"string"},"publicKeys":{"type":"array","items":{"type":"string"}}},"required":["id","identityId","configurationType","jwksUrl","boundIssuer","boundAudiences","boundSubject","createdAt","updatedAt","jwksCaCert","publicKeys"],"additionalProperties":false}},"required":["identityJwtAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateJwtAuth","tags":["JWT Auth"],"description":"Update JWT Auth configuration on machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"configurationType":{"type":"string","enum":["jwks"],"description":"The configuration for validating JWTs. Must be one of: 'jwks', 'static'"},"jwksUrl":{"type":"string","format":"uri","description":"The URL of the JWKS endpoint. Required if configurationType is 'jwks'. This endpoint must serve JSON Web Key Sets (JWKS) containing the public keys used to verify JWT signatures."},"jwksCaCert":{"type":"string","default":"","description":"The PEM-encoded CA certificate for validating the TLS connection to the JWKS endpoint."},"publicKeys":{"type":"array","items":{"type":"string"},"default":[],"description":"A list of PEM-encoded public keys used to verify JWT signatures. Required if configurationType is 'static'. Each key must be in RSA or ECDSA format and properly PEM-encoded with BEGIN/END markers."},"boundIssuer":{"type":"string","default":"","description":"The new unique identifier of the JWT provider."},"boundAudiences":{"type":"string","default":"","description":"The new list of intended recipients."},"boundClaims":{"type":"object","additionalProperties":{"type":"string"},"description":"The new attributes that should be present in the JWT for it to be valid."},"boundSubject":{"type":"string","default":"","description":"The new expected principal that is the subject of the JWT."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The new IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The new lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The new maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The new maximum number of times that an access token can be used."}},"required":["configurationType","jwksUrl"],"additionalProperties":false},{"type":"object","properties":{"configurationType":{"type":"string","enum":["static"],"description":"The configuration for validating JWTs. Must be one of: 'jwks', 'static'"},"jwksUrl":{"type":"string","default":"","description":"The URL of the JWKS endpoint. Required if configurationType is 'jwks'. This endpoint must serve JSON Web Key Sets (JWKS) containing the public keys used to verify JWT signatures."},"jwksCaCert":{"type":"string","default":"","description":"The PEM-encoded CA certificate for validating the TLS connection to the JWKS endpoint."},"publicKeys":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"description":"A list of PEM-encoded public keys used to verify JWT signatures. Required if configurationType is 'static'. Each key must be in RSA or ECDSA format and properly PEM-encoded with BEGIN/END markers."},"boundIssuer":{"type":"string","default":"","description":"The new unique identifier of the JWT provider."},"boundAudiences":{"type":"string","default":"","description":"The new list of intended recipients."},"boundClaims":{"type":"object","additionalProperties":{"type":"string"},"description":"The new attributes that should be present in the JWT for it to be valid."},"boundSubject":{"type":"string","default":"","description":"The new expected principal that is the subject of the JWT."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The new IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The new lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The new maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The new maximum number of times that an access token can be used."}},"required":["configurationType","publicKeys"],"additionalProperties":false}]}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityJwtAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"identityId":{"type":"string","format":"uuid"},"configurationType":{"type":"string"},"jwksUrl":{"type":"string"},"boundIssuer":{"type":"string"},"boundAudiences":{"type":"string"},"boundClaims":{},"boundSubject":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"accessTokenPeriod":{"type":"number","default":0},"jwksCaCert":{"type":"string"},"publicKeys":{"type":"array","items":{"type":"string"}}},"required":["id","identityId","configurationType","jwksUrl","boundIssuer","boundAudiences","boundSubject","createdAt","updatedAt","jwksCaCert","publicKeys"],"additionalProperties":false}},"required":["identityJwtAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getJwtAuth","tags":["JWT Auth"],"description":"Retrieve JWT Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to retrieve the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityJwtAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"identityId":{"type":"string","format":"uuid"},"configurationType":{"type":"string"},"jwksUrl":{"type":"string"},"boundIssuer":{"type":"string"},"boundAudiences":{"type":"string"},"boundClaims":{},"boundSubject":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"accessTokenPeriod":{"type":"number","default":0},"jwksCaCert":{"type":"string"},"publicKeys":{"type":"array","items":{"type":"string"}}},"required":["id","identityId","configurationType","jwksUrl","boundIssuer","boundAudiences","boundSubject","createdAt","updatedAt","jwksCaCert","publicKeys"],"additionalProperties":false}},"required":["identityJwtAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteJwtAuth","tags":["JWT Auth"],"description":"Delete JWT Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityJwtAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"identityId":{"type":"string","format":"uuid"},"configurationType":{"type":"string"},"jwksUrl":{"type":"string"},"boundIssuer":{"type":"string"},"boundAudiences":{"type":"string"},"boundClaims":{},"boundSubject":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"accessTokenPeriod":{"type":"number","default":0}},"required":["id","identityId","configurationType","jwksUrl","boundIssuer","boundAudiences","boundSubject","createdAt","updatedAt"],"additionalProperties":false}},"required":["identityJwtAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/spiffe-auth/login":{"post":{"operationId":"loginWithSpiffeAuth","tags":["SPIFFE Auth"],"description":"Login with SPIFFE Auth (JWT-SVID) for machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","description":"The ID of the machine identity to login."},"jwt":{"type":"string","description":"The JWT-SVID token to authenticate with."},"organizationSlug":{"type":"string","minLength":1,"maxLength":64,"description":"When set, this will scope the login session to the specified organization the machine identity has access to. If omitted, the session defaults to the organization where the machine identity was created in."}},"required":["identityId","jwt"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/spiffe-auth/identities/{identityId}":{"post":{"operationId":"attachSpiffeAuth","tags":["SPIFFE Auth"],"description":"Attach SPIFFE Auth configuration onto machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"trustDomain":{"type":"string","minLength":1,"description":"The SPIFFE trust domain (e.g. prod.example.com)."},"allowedSpiffeIds":{"type":"string","minLength":1,"description":"Comma-separated list of allowed SPIFFE ID patterns. Supports picomatch glob patterns (e.g. spiffe://prod.example.com/**)."},"allowedAudiences":{"type":"string","minLength":1,"description":"Comma-separated list of allowed audiences for JWT-SVID validation."},"trustBundleDistribution":{"anyOf":[{"type":"object","properties":{"profile":{"type":"string","enum":["static"],"description":"The trust bundle distribution profile. Must be one of: 'static' (admin uploads JWKS), 'https_web_bundle' (auto-refresh from HTTPS endpoint)."},"bundle":{"type":"string","minLength":1,"description":"The JWKS JSON containing public keys for JWT-SVID verification. Required when profile is 'static'."}},"required":["profile","bundle"],"additionalProperties":false},{"type":"object","properties":{"profile":{"type":"string","enum":["https_web_bundle"],"description":"The trust bundle distribution profile. Must be one of: 'static' (admin uploads JWKS), 'https_web_bundle' (auto-refresh from HTTPS endpoint)."},"endpointUrl":{"type":"string","format":"uri","description":"The SPIRE bundle endpoint URL for automatic trust bundle retrieval. Required when profile is 'https_web_bundle'."},"caCert":{"type":"string","description":"Optional PEM-encoded root CA certificate for verifying the bundle endpoint TLS connection. Defaults to system root CAs when not provided."},"refreshHintSeconds":{"type":"integer","minimum":0,"default":3600,"description":"The interval in seconds between bundle refresh attempts. Defaults to 3600."}},"required":["profile","endpointUrl"],"additionalProperties":false}]},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."}},"required":["trustDomain","allowedSpiffeIds","allowedAudiences","trustBundleDistribution"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to attach the configuration onto."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identitySpiffeAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"identityId":{"type":"string","format":"uuid"},"trustDomain":{"type":"string"},"allowedSpiffeIds":{"type":"string"},"allowedAudiences":{"type":"string"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"trustBundleDistribution":{"anyOf":[{"type":"object","properties":{"profile":{"type":"string","enum":["static"]},"bundle":{"type":"string"}},"required":["profile","bundle"],"additionalProperties":false},{"type":"object","properties":{"profile":{"type":"string","enum":["https_web_bundle"]},"endpointUrl":{"type":"string"},"caCert":{"type":"string"},"refreshHintSeconds":{"type":"number"},"cachedBundleLastRefreshedAt":{"type":"string","format":"date-time","nullable":true}},"required":["profile","endpointUrl","caCert","refreshHintSeconds"],"additionalProperties":false}]}},"required":["id","identityId","trustDomain","allowedSpiffeIds","allowedAudiences","createdAt","updatedAt","trustBundleDistribution"],"additionalProperties":false}},"required":["identitySpiffeAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateSpiffeAuth","tags":["SPIFFE Auth"],"description":"Update SPIFFE Auth configuration on machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"trustDomain":{"type":"string","minLength":1,"description":"The SPIFFE trust domain (e.g. prod.example.com)."},"allowedSpiffeIds":{"type":"string","minLength":1,"description":"Comma-separated list of allowed SPIFFE ID patterns. Supports picomatch glob patterns (e.g. spiffe://prod.example.com/**)."},"allowedAudiences":{"type":"string","minLength":1,"description":"Comma-separated list of allowed audiences for JWT-SVID validation."},"trustBundleDistribution":{"anyOf":[{"type":"object","properties":{"profile":{"type":"string","enum":["static"],"description":"The trust bundle distribution profile. Must be one of: 'static' (admin uploads JWKS), 'https_web_bundle' (auto-refresh from HTTPS endpoint)."},"bundle":{"type":"string","minLength":1,"description":"The JWKS JSON containing public keys for JWT-SVID verification. Required when profile is 'static'."}},"required":["profile","bundle"],"additionalProperties":false},{"type":"object","properties":{"profile":{"type":"string","enum":["https_web_bundle"],"description":"The trust bundle distribution profile. Must be one of: 'static' (admin uploads JWKS), 'https_web_bundle' (auto-refresh from HTTPS endpoint)."},"endpointUrl":{"type":"string","format":"uri","description":"The SPIRE bundle endpoint URL for automatic trust bundle retrieval. Required when profile is 'https_web_bundle'."},"caCert":{"type":"string","description":"Optional PEM-encoded root CA certificate for verifying the bundle endpoint TLS connection. Defaults to system root CAs when not provided."},"refreshHintSeconds":{"type":"integer","minimum":0,"default":3600,"description":"The interval in seconds between bundle refresh attempts. Defaults to 3600."}},"required":["profile","endpointUrl"],"additionalProperties":false}]},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identitySpiffeAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"identityId":{"type":"string","format":"uuid"},"trustDomain":{"type":"string"},"allowedSpiffeIds":{"type":"string"},"allowedAudiences":{"type":"string"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"trustBundleDistribution":{"anyOf":[{"type":"object","properties":{"profile":{"type":"string","enum":["static"]},"bundle":{"type":"string"}},"required":["profile","bundle"],"additionalProperties":false},{"type":"object","properties":{"profile":{"type":"string","enum":["https_web_bundle"]},"endpointUrl":{"type":"string"},"caCert":{"type":"string"},"refreshHintSeconds":{"type":"number"},"cachedBundleLastRefreshedAt":{"type":"string","format":"date-time","nullable":true}},"required":["profile","endpointUrl","caCert","refreshHintSeconds"],"additionalProperties":false}]}},"required":["id","identityId","trustDomain","allowedSpiffeIds","allowedAudiences","createdAt","updatedAt","trustBundleDistribution"],"additionalProperties":false}},"required":["identitySpiffeAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getSpiffeAuth","tags":["SPIFFE Auth"],"description":"Retrieve SPIFFE Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to retrieve the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identitySpiffeAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"identityId":{"type":"string","format":"uuid"},"trustDomain":{"type":"string"},"allowedSpiffeIds":{"type":"string"},"allowedAudiences":{"type":"string"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"trustBundleDistribution":{"anyOf":[{"type":"object","properties":{"profile":{"type":"string","enum":["static"]},"bundle":{"type":"string"}},"required":["profile","bundle"],"additionalProperties":false},{"type":"object","properties":{"profile":{"type":"string","enum":["https_web_bundle"]},"endpointUrl":{"type":"string"},"caCert":{"type":"string"},"refreshHintSeconds":{"type":"number"},"cachedBundleLastRefreshedAt":{"type":"string","format":"date-time","nullable":true}},"required":["profile","endpointUrl","caCert","refreshHintSeconds"],"additionalProperties":false}]}},"required":["id","identityId","trustDomain","allowedSpiffeIds","allowedAudiences","createdAt","updatedAt","trustBundleDistribution"],"additionalProperties":false}},"required":["identitySpiffeAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteSpiffeAuth","tags":["SPIFFE Auth"],"description":"Delete SPIFFE Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the auth method for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identitySpiffeAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"identityId":{"type":"string","format":"uuid"},"trustDomain":{"type":"string"},"allowedSpiffeIds":{"type":"string"},"allowedAudiences":{"type":"string"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"trustBundleDistribution":{"anyOf":[{"type":"object","properties":{"profile":{"type":"string","enum":["static"]},"bundle":{"type":"string"}},"required":["profile","bundle"],"additionalProperties":false},{"type":"object","properties":{"profile":{"type":"string","enum":["https_web_bundle"]},"endpointUrl":{"type":"string"},"caCert":{"type":"string"},"refreshHintSeconds":{"type":"number"},"cachedBundleLastRefreshedAt":{"type":"string","format":"date-time","nullable":true}},"required":["profile","endpointUrl","caCert","refreshHintSeconds"],"additionalProperties":false}]}},"required":["id","identityId","trustDomain","allowedSpiffeIds","allowedAudiences","createdAt","updatedAt","trustBundleDistribution"],"additionalProperties":false}},"required":["identitySpiffeAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/spiffe-auth/identities/{identityId}/refresh-bundle":{"post":{"operationId":"refreshSpiffeBundle","tags":["SPIFFE Auth"],"description":"Force-refresh the cached SPIFFE trust bundle for a remote-configured machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to force-refresh the cached SPIFFE trust bundle for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identitySpiffeAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"identityId":{"type":"string","format":"uuid"},"trustDomain":{"type":"string"},"allowedSpiffeIds":{"type":"string"},"allowedAudiences":{"type":"string"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"trustBundleDistribution":{"anyOf":[{"type":"object","properties":{"profile":{"type":"string","enum":["static"]},"bundle":{"type":"string"}},"required":["profile","bundle"],"additionalProperties":false},{"type":"object","properties":{"profile":{"type":"string","enum":["https_web_bundle"]},"endpointUrl":{"type":"string"},"caCert":{"type":"string"},"refreshHintSeconds":{"type":"number"},"cachedBundleLastRefreshedAt":{"type":"string","format":"date-time","nullable":true}},"required":["profile","endpointUrl","caCert","refreshHintSeconds"],"additionalProperties":false}]}},"required":["id","identityId","trustDomain","allowedSpiffeIds","allowedAudiences","createdAt","updatedAt","trustBundleDistribution"],"additionalProperties":false}},"required":["identitySpiffeAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/ldap-auth/login":{"post":{"operationId":"loginWithLdapAuth","tags":["LDAP Auth"],"description":"Login with LDAP Auth for machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","format":"uuid","description":"The ID of the machine identity to login."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"The username of the LDAP user to login."},"password":{"type":"string","minLength":1,"maxLength":1024,"description":"The password of the LDAP user to login."},"organizationSlug":{"type":"string","minLength":1,"maxLength":64,"description":"When set, this will scope the login session to the specified organization the machine identity has access to. If omitted, the session defaults to the organization where the machine identity was created in."}},"required":["identityId","username","password"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"accessToken":{"type":"string"},"expiresIn":{"type":"number"},"accessTokenMaxTTL":{"type":"number"},"tokenType":{"type":"string","enum":["Bearer"]}},"required":["accessToken","expiresIn","accessTokenMaxTTL","tokenType"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/ldap-auth/identities/{identityId}":{"post":{"operationId":"attachLdapAuth","tags":["LDAP Auth"],"description":"Attach LDAP Auth configuration onto machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"templateId":{"type":"string","description":"The ID of the identity auth template to attach the configuration onto."},"searchFilter":{"type":"string","minLength":1,"default":"(uid={{username}})","description":"The filter to use to search for the LDAP user."},"allowedFields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"description":"The comma-separated array of key/value pairs of required fields that the LDAP entry must have in order to authenticate."},"ldapCaCertificate":{"type":"string","description":"The PEM-encoded CA certificate for the LDAP server."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":1,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."},"lockoutEnabled":{"type":"boolean","default":true,"description":"Whether the lockout feature is enabled."},"lockoutThreshold":{"type":"number","minimum":1,"maximum":30,"default":3,"description":"The amount of times login must fail before locking the identity auth method."},"lockoutDurationSeconds":{"type":"number","minimum":30,"maximum":86400,"default":300,"description":"How long an identity auth method lockout lasts."},"lockoutCounterResetSeconds":{"type":"number","minimum":5,"maximum":3600,"default":30,"description":"How long to wait from the most recent failed login until resetting the lockout counter."}},"required":["templateId"],"additionalProperties":false},{"type":"object","properties":{"url":{"type":"string","description":"The URL of the LDAP server."},"bindDN":{"type":"string","description":"The DN of the user to bind to the LDAP server."},"bindPass":{"type":"string","description":"The password of the user to bind to the LDAP server."},"searchBase":{"type":"string","description":"The base DN to search for the LDAP user."},"searchFilter":{"type":"string","minLength":1,"default":"(uid={{username}})","description":"The filter to use to search for the LDAP user."},"allowedFields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"description":"The comma-separated array of key/value pairs of required fields that the LDAP entry must have in order to authenticate."},"ldapCaCertificate":{"type":"string","description":"The PEM-encoded CA certificate for the LDAP server."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"default":[{"ipAddress":"0.0.0.0/0"},{"ipAddress":"::/0"}],"description":"The IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"default":2592000,"description":"The lifetime for an access token in seconds."},"accessTokenMaxTTL":{"type":"integer","minimum":1,"maximum":315360000,"default":2592000,"description":"The maximum lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"default":0,"description":"The maximum number of times that an access token can be used."},"lockoutEnabled":{"type":"boolean","default":true,"description":"Whether the lockout feature is enabled."},"lockoutThreshold":{"type":"number","minimum":1,"maximum":30,"default":3,"description":"The amount of times login must fail before locking the identity auth method."},"lockoutDurationSeconds":{"type":"number","minimum":30,"maximum":86400,"default":300,"description":"How long an identity auth method lockout lasts."},"lockoutCounterResetSeconds":{"type":"number","minimum":5,"maximum":3600,"default":30,"description":"How long to wait from the most recent failed login until resetting the lockout counter."}},"required":["url","bindDN","bindPass","searchBase"],"additionalProperties":false}]}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to attach the configuration onto."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityLdapAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"identityId":{"type":"string","format":"uuid"},"url":{"type":"string"},"searchBase":{"type":"string"},"searchFilter":{"type":"string"},"allowedFields":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"accessTokenPeriod":{"type":"number","default":0},"templateId":{"type":"string","format":"uuid","nullable":true},"lockoutEnabled":{"type":"boolean","default":true},"lockoutThreshold":{"type":"number","default":3},"lockoutDurationSeconds":{"type":"number","default":300},"lockoutCounterResetSeconds":{"type":"number","default":30}},"required":["id","identityId","url","searchBase","searchFilter","createdAt","updatedAt"],"additionalProperties":false}},"required":["identityLdapAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateLdapAuth","tags":["LDAP Auth"],"description":"Update LDAP Auth configuration on machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","minLength":1,"description":"The new URL of the LDAP server."},"bindDN":{"type":"string","minLength":1,"description":"The new DN of the user to bind to the LDAP server."},"bindPass":{"type":"string","minLength":1,"description":"The new password of the user to bind to the LDAP server."},"searchBase":{"type":"string","minLength":1,"description":"The new base DN to search for the LDAP user."},"templateId":{"type":"string","description":"The ID of the identity auth template to update the configuration to."},"searchFilter":{"type":"string","minLength":1,"description":"The new filter to use to search for the LDAP user."},"allowedFields":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"description":"The comma-separated list of allowed fields to return from the LDAP user."},"accessTokenTrustedIps":{"type":"array","items":{"type":"object","properties":{"ipAddress":{"type":"string"}},"required":["ipAddress"],"additionalProperties":false},"minItems":1,"description":"The new IPs or CIDR ranges that access tokens can be used from."},"accessTokenTTL":{"type":"integer","minimum":0,"maximum":315360000,"description":"The new lifetime for an access token in seconds."},"accessTokenNumUsesLimit":{"type":"integer","minimum":0,"description":"The new maximum number of times that an access token can be used."},"accessTokenMaxTTL":{"type":"integer","maximum":315360000,"minimum":0,"description":"The new maximum lifetime for an access token in seconds."},"lockoutEnabled":{"type":"boolean","description":"Whether the lockout feature is enabled."},"lockoutThreshold":{"type":"number","minimum":1,"maximum":30,"description":"The amount of times login must fail before locking the identity auth method."},"lockoutDurationSeconds":{"type":"number","minimum":30,"maximum":86400,"description":"How long an identity auth method lockout lasts."},"lockoutCounterResetSeconds":{"type":"number","minimum":5,"maximum":3600,"description":"How long to wait from the most recent failed login until resetting the lockout counter."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the configuration for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityLdapAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"identityId":{"type":"string","format":"uuid"},"url":{"type":"string"},"searchBase":{"type":"string"},"searchFilter":{"type":"string"},"allowedFields":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"accessTokenPeriod":{"type":"number","default":0},"templateId":{"type":"string","format":"uuid","nullable":true},"lockoutEnabled":{"type":"boolean","default":true},"lockoutThreshold":{"type":"number","default":3},"lockoutDurationSeconds":{"type":"number","default":300},"lockoutCounterResetSeconds":{"type":"number","default":30}},"required":["id","identityId","url","searchBase","searchFilter","createdAt","updatedAt"],"additionalProperties":false}},"required":["identityLdapAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getLdapAuth","tags":["LDAP Auth"],"description":"Retrieve LDAP Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to retrieve the configuration for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityLdapAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"identityId":{"type":"string","format":"uuid"},"url":{"type":"string"},"searchBase":{"type":"string"},"searchFilter":{"type":"string"},"allowedFields":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"accessTokenPeriod":{"type":"number","default":0},"templateId":{"type":"string","nullable":true},"lockoutEnabled":{"type":"boolean","default":true},"lockoutThreshold":{"type":"number","default":3},"lockoutDurationSeconds":{"type":"number","default":300},"lockoutCounterResetSeconds":{"type":"number","default":30},"bindDN":{"type":"string"},"ldapCaCertificate":{"type":"string"}},"required":["id","identityId","url","searchBase","searchFilter","createdAt","updatedAt","bindDN"],"additionalProperties":false}},"required":["identityLdapAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteLdapAuth","tags":["LDAP Auth"],"description":"Delete LDAP Auth configuration on machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to revoke the configuration for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityLdapAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"accessTokenTTL":{"type":"number","default":7200},"accessTokenMaxTTL":{"type":"number","default":7200},"accessTokenNumUsesLimit":{"type":"number","default":0},"accessTokenTrustedIps":{},"identityId":{"type":"string","format":"uuid"},"url":{"type":"string"},"searchBase":{"type":"string"},"searchFilter":{"type":"string"},"allowedFields":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"accessTokenPeriod":{"type":"number","default":0},"templateId":{"type":"string","format":"uuid","nullable":true},"lockoutEnabled":{"type":"boolean","default":true},"lockoutThreshold":{"type":"number","default":3},"lockoutDurationSeconds":{"type":"number","default":300},"lockoutCounterResetSeconds":{"type":"number","default":30}},"required":["id","identityId","url","searchBase","searchFilter","createdAt","updatedAt"],"additionalProperties":false}},"required":["identityLdapAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/auth/ldap-auth/identities/{identityId}/clear-lockouts":{"post":{"operationId":"clearLdapAuthLockouts","tags":["LDAP Auth"],"description":"Clear LDAP Auth Lockouts for machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to clear the client lockouts from."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"number"}},"required":["deleted"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/organization/audit-log-settings":{"get":{"operationId":"getOrganizationAuditLogSettings","tags":["Audit Logs"],"description":"Get which audit log event classes the organization records","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"auditLogSettings":{"type":"object","properties":{"eventClasses":{"type":"array","items":{"type":"object","properties":{"eventClass":{"type":"string","enum":["management","authentication","authorization","data-access"],"description":"The audit log event class: management, authentication, data-access, or authorization."},"isEnabled":{"type":"boolean","description":"Whether events of this class are recorded."}},"required":["eventClass","isEnabled"],"additionalProperties":false}},"shouldUseNewPrivilegeSystem":{"type":"boolean","description":"Whether the organization is on the new privilege system. Permission denials (the authorization class) are only recorded on the new privilege system."}},"required":["eventClasses","shouldUseNewPrivilegeSystem"],"additionalProperties":false}},"required":["auditLogSettings"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"put":{"operationId":"updateOrganizationAuditLogSettings","tags":["Audit Logs"],"description":"Update which audit log event classes the organization records. Requires the organization admin role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eventClasses":{"type":"array","items":{"type":"object","properties":{"eventClass":{"type":"string","enum":["management","authentication","authorization","data-access"],"description":"The audit log event class: management, authentication, data-access, or authorization."},"isEnabled":{"type":"boolean","description":"Whether to record events of this class for the organization. This only covers organization-level events; each project has its own setting."}},"required":["eventClass","isEnabled"],"additionalProperties":false},"minItems":1,"maxItems":4,"description":"Every event class except management and data-access, each exactly once. The request replaces the current settings. Management and data-access events are always recorded, so a request that includes either class is rejected. The authorization class can only be turned on for organizations on the new privilege system; otherwise the request is rejected."}},"required":["eventClasses"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"auditLogSettings":{"type":"object","properties":{"eventClasses":{"type":"array","items":{"type":"object","properties":{"eventClass":{"type":"string","enum":["management","authentication","authorization","data-access"],"description":"The audit log event class: management, authentication, data-access, or authorization."},"isEnabled":{"type":"boolean","description":"Whether events of this class are recorded."}},"required":["eventClass","isEnabled"],"additionalProperties":false}},"shouldUseNewPrivilegeSystem":{"type":"boolean","description":"Whether the organization is on the new privilege system. Permission denials (the authorization class) are only recorded on the new privilege system."}},"required":["eventClasses","shouldUseNewPrivilegeSystem"],"additionalProperties":false}},"required":["auditLogSettings"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/organization/audit-logs":{"get":{"operationId":"listOrganizationAuditLogs","tags":["Audit Logs"],"description":"Get all audit logs for an organization","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"Optionally filter logs by project ID. If not provided, logs from the entire organization will be returned."},{"schema":{"type":"string"},"in":"query","name":"environment","required":false,"description":"The environment to filter logs by. If not provided, logs from all environments will be returned. Note that the projectId parameter must also be provided."},{"schema":{"type":"string","enum":["platform","kmipClient","user","service","identity","scimClient","acmeProfile","acmeAccount","estAccount","scepAccount","unknownUser","gateway","relay","kmipServer","agentVaultProxy"]},"in":"query","name":"actorType","required":false,"description":"The type of actor to filter audit logs by. Must be provided when the actor parameter targets a non-user actor type (e.g. identity, kmipClient)."},{"schema":{"type":"string"},"in":"query","name":"secretPath","required":false,"description":"The path of the secret to query audit logs for. Note that the projectId parameter must also be provided."},{"schema":{"type":"string"},"in":"query","name":"secretKey","required":false,"description":"The key of the secret to query audit logs for. Note that the projectId parameter must also be provided."},{"schema":{"allOf":[{"anyOf":[{"not":{}},{"type":"string","maxLength":17467}]},{"anyOf":[{"not":{}},{"type":"array","items":{"type":"string","enum":["get-secrets","get-secret","reveal-secret","create-secret","create-secrets","update-secret","update-secrets","move-secrets","search-secrets-by-value","duplicate-secret","delete-secret","delete-secrets","redact-secret-version-value","get-project-key","authorize-integration","update-integration-auth","unauthorize-integration","create-integration","delete-integration","manual-sync-integration","add-trusted-ip","update-trusted-ip","delete-trusted-ip","create-service-token","delete-service-token","create-sub-organization","update-sub-organization","delete-sub-organization","join-sub-organization","create-identity","update-identity","delete-identity","update-user-org-membership","delete-user-org-membership","create-identity-org-membership","update-identity-org-membership","delete-identity-org-membership","create-identity-project-membership","update-identity-project-membership","delete-identity-project-membership","machine-identity-auth-template-create","machine-identity-auth-template-update","machine-identity-auth-template-delete","login-identity-universal-auth","login-identity-universal-auth-failed","add-identity-universal-auth","update-identity-universal-auth","get-identity-universal-auth","revoke-identity-universal-auth","create-token-identity-token-auth","update-token-identity-token-auth","get-tokens-identity-token-auth","get-token-identity-token-auth","add-identity-token-auth","update-identity-token-auth","get-identity-token-auth","revoke-identity-token-auth","login-identity-kubernetes-auth","login-identity-kubernetes-auth-failed","add-identity-kubernetes-auth","update-identity-kubernetes-auth","get-identity-kubernetes-auth","revoke-identity-kubernetes-auth","login-identity-oidc-auth","login-identity-oidc-auth-failed","add-identity-oidc-auth","update-identity-oidc-auth","get-identity-oidc-auth","revoke-identity-oidc-auth","login-identity-jwt-auth","login-identity-jwt-auth-failed","add-identity-jwt-auth","update-identity-jwt-auth","get-identity-jwt-auth","revoke-identity-jwt-auth","login-identity-spiffe-auth","login-identity-spiffe-auth-failed","add-identity-spiffe-auth","update-identity-spiffe-auth","get-identity-spiffe-auth","revoke-identity-spiffe-auth","refresh-identity-spiffe-auth-bundle","create-identity-universal-auth-client-secret","revoke-identity-universal-auth-client-secret","clear-identity-universal-auth-lockouts","clear-identity-ldap-auth-lockouts","get-identity-universal-auth-client-secret","get-identity-universal-auth-client-secret-by-id","login-identity-gcp-auth","login-identity-gcp-auth-failed","add-identity-gcp-auth","update-identity-gcp-auth","revoke-identity-gcp-auth","get-identity-gcp-auth","login-identity-alicloud-auth","login-identity-alicloud-auth-failed","add-identity-alicloud-auth","update-identity-alicloud-auth","revoke-identity-alicloud-auth","get-identity-alicloud-auth","login-identity-tls-cert-auth","login-identity-tls-cert-auth-failed","add-identity-tls-cert-auth","update-identity-tls-cert-auth","revoke-identity-tls-cert-auth","get-identity-tls-cert-auth","login-identity-aws-auth","login-identity-aws-auth-failed","add-identity-aws-auth","update-identity-aws-auth","revoke-identity-aws-auth","get-identity-aws-auth","login-identity-oci-auth","login-identity-oci-auth-failed","add-identity-oci-auth","update-identity-oci-auth","revoke-identity-oci-auth","get-identity-oci-auth","login-identity-azure-auth","login-identity-azure-auth-failed","add-identity-azure-auth","update-identity-azure-auth","get-identity-azure-auth","revoke-identity-azure-auth","login-identity-ldap-auth","login-identity-ldap-auth-failed","add-identity-ldap-auth","update-identity-ldap-auth","get-identity-ldap-auth","revoke-identity-ldap-auth","create-environment","update-environment","delete-environment","restore-environment","get-environment","add-project-member","add-project-members","remove-project-member","get-project-member-permission-audit","get-project-identity-permission-audit","create-folder","update-folder","delete-folder","move-folder","create-webhook","update-webhook-status","delete-webhook","webhook-triggered","get-secret-imports","get-secret-import","create-secret-import","update-secret-import","delete-secret-import","update-user-project-role","update-user-project-denied-permissions","add-project-group","update-project-group","remove-project-group","secret-approval-merged","secret-approval-request","secret-approval-closed","secret-approval-reopened","secret-approval-request-review","get-azure-ad-templates","get-adcs-templates","create-certificate-authority","get-certificate-authority","get-certificate-authorities","update-certificate-authority","delete-certificate-authority","renew-certificate-authority","export-cert-manager-project","get-certificate-authority-csr","get-certificate-authority-certs","get-certificate-authority-cert","sign-intermediate","import-certificate-authority-cert","get-certificate-authority-crls","generate-ca-certificate","install-ca-cert-venafi","install-ca-cert-adcs","create-ca-signing-config","get-ca-signing-config","update-ca-signing-config","get-ca-auto-renewal-config","update-ca-auto-renewal-config","issue-cert","import-cert","sign-cert","get-ca-certificate-templates","get-cert","delete-cert","revoke-cert","assign-cert-to-application","get-cert-body","get-cert-private-key","get-cert-bundle","export-cert-pkcs12","create-pki-alert","get-pki-alert","update-pki-alert","delete-pki-alert","create-certificate-inventory-view","update-certificate-inventory-view","delete-certificate-inventory-view","create-pki-collection","get-pki-collection","update-pki-collection","delete-pki-collection","get-pki-collection-items","add-pki-collection-item","delete-pki-collection-item","create-pki-subscriber","update-pki-subscriber","delete-pki-subscriber","get-pki-subscriber","issue-pki-subscriber-cert","sign-pki-subscriber-cert","automated-renew-subscriber-cert","automated-renew-certificate","automated-renew-certificate-failed","list-pki-subscriber-certs","get-subscriber-active-cert-bundle","create-kms","update-kms","delete-kms","get-kms","update-project-kms","get-project-kms-backup","load-project-kms-backup","org-admin-accessed-project","org-admin-bypassed-sso","user-login","select-organization","select-sub-organization","create-certificate-policy","update-certificate-policy","delete-certificate-policy","get-certificate-policy","list-certificate-policies","create-certificate-template-est-config","update-certificate-template-est-config","get-certificate-template-est-config","create-certificate-profile","update-certificate-profile","delete-certificate-profile","get-certificate-profile","list-certificate-profiles","create-pki-application","update-pki-application","delete-pki-application","get-pki-application","list-pki-applications","attach-pki-application-profiles","detach-pki-application-profile","add-pki-application-member","update-pki-application-member-role","remove-pki-application-member","list-pki-application-members","get-pki-application-enrollment","set-pki-application-api-enrollment","clear-pki-application-api-enrollment","set-pki-application-est-enrollment","clear-pki-application-est-enrollment","set-pki-application-acme-enrollment","clear-pki-application-acme-enrollment","reveal-pki-application-acme-eab-secret","rotate-pki-application-acme-eab-secret","set-pki-application-scep-enrollment","clear-pki-application-scep-enrollment","get-cert-manager-instance-state","set-cert-manager-active-project","invite-cert-manager-users","update-cert-manager-user","remove-cert-manager-user","remove-cert-manager-users-batch","add-cert-manager-identity","update-cert-manager-identity","remove-cert-manager-identity","add-cert-manager-group","update-cert-manager-group","remove-cert-manager-group","issue-certificate-from-profile","sign-certificate-from-profile","order-certificate-from-profile","renew-certificate","get-certificate-profile-latest-active-bundle","update-certificate-renewal-config","update-certificate-metadata","update-certificate-cleanup-config","certificate-cleanup-completed","disable-certificate-renewal-config","create-certificate-request","get-certificate-request","get-certificate-from-request","list-certificate-requests","trigger-certificate-request-validation","cancel-certificate-request","attempt-create-slack-integration","attempt-reinstall-slack-integration","get-project-slack-config","update-project-slack-config","get-slack-integration","update-slack-integration","delete-slack-integration","get-project-workflow-integration-config","update-project-workflow-integration-config","integration-synced","create-cmek","update-cmek","rotate-cmek","delete-cmek","get-cmeks","get-cmek","cmek-encrypt","cmek-decrypt","cmek-sign","cmek-verify","cmek-generate-mac","cmek-verify-mac","cmek-list-signing-algorithms","cmek-get-public-key","cmek-get-private-key","cmek-bulk-export-private-keys","cmek-bulk-import-keys","update-external-group-org-role-mapping","get-external-group-org-role-mapping","create-group","update-group","delete-group","link-group-to-sub-org","update-group-org-membership","unlink-group-from-sub-org","add-user-to-group","remove-user-from-group","add-identity-to-group","remove-identity-from-group","add-group-to-project","update-group-project-membership","remove-group-from-project","get-project-templates","get-project-template","create-project-template","update-project-template","delete-project-template","get-app-connections","get-available-app-connections-details","get-app-connection","create-app-connection","update-app-connection","delete-app-connection","create-hsm-connector","update-hsm-connector","delete-hsm-connector","test-hsm-connector","get-app-connection-usage","migrate-app-connection","rotate-app-connection-credentials","create-github-app","delete-github-app","create-shared-secret","create-secret-request","delete-shared-secret","read-shared-secret","get-secret-syncs","get-secret-sync","create-secret-sync","update-secret-sync","delete-secret-sync","secret-sync-sync-secrets","secret-sync-import-secrets","secret-sync-remove-secrets","get-pki-syncs","get-pki-sync","get-pki-sync-certificates","create-pki-sync","update-pki-sync","delete-pki-sync","pki-sync-sync-certificates","pki-sync-import-certificates","pki-sync-remove-certificates","pki-sync-health-check","pki-sync-test-health-check","pki-sync-link-certificates","pki-sync-unlink-certificates","pki-sync-skip-certificate","pki-sync-set-default-certificate","pki-sync-clear-default-certificate","oidc-group-membership-mapping-assign-user","oidc-group-membership-mapping-remove-user","oidc-provisioned-placeholder-adopted","sso-user-profile-synced","sso-user-email-sync-skipped","create-kmip-client","update-kmip-client","delete-kmip-client","get-kmip-client","get-kmip-clients","create-kmip-client-certificate","setup-kmip","get-kmip","register-kmip-server","kmip-server-connect","kmip-operation-create","kmip-operation-get","kmip-operation-destroy","kmip-operation-get-attributes","kmip-operation-activate","kmip-operation-revoke","kmip-operation-locate","kmip-operation-register","get-secret-rotations","get-secret-rotation","get-secret-rotation-generated-credentials","create-secret-rotation","update-secret-rotation","delete-secret-rotation","move-secret-rotation","secret-rotation-rotate-secrets","reconcile-secret-rotation","secret-rotation-check-credentials","project-access-request","microsoft-teams-workflow-integration-create","microsoft-teams-workflow-integration-delete","microsoft-teams-workflow-integration-update","microsoft-teams-workflow-integration-check-installation-status","microsoft-teams-workflow-integration-get-teams","microsoft-teams-workflow-integration-get","microsoft-teams-workflow-integration-list","project-assume-privileges-session-start","project-assume-privileges-session-end","get-project-pit-commits","get-project-pit-commit-authors","get-project-pit-commit-changes","get-project-pit-commit-count","pit-rollback-commit","pit-revert-commit","pit-get-folder-state","pit-compare-folder-states","pit-process-new-commit-raw","secret-scanning-data-source-list","secret-scanning-data-source-create","secret-scanning-data-source-update","secret-scanning-data-source-delete","secret-scanning-data-source-get","secret-scanning-data-source-trigger-scan","secret-scanning-data-source-scan","secret-scanning-resource-list","secret-scanning-scan-list","secret-scanning-finding-list","secret-scanning-finding-update","secret-scanning-config-get","secret-scanning-config-update","update-org","enable-org-wide-secret-value-tracking","create-project","update-project","delete-project","create-project-role","update-project-role","delete-project-role","list-project-roles","get-project-role","create-org-role","update-org-role","delete-org-role","create-secret-reminder","get-secret-reminder","delete-secret-reminder","dashboard-list-secrets","dashboard-get-secret-value","dashboard-get-secret-version-value","search-secrets-by-metadata","view-insights-auth-methods","view-insights-secrets-management-calendar","view-insights-secrets-management-access-volume","view-insights-secrets-management-org-auth-method-distribution","view-insights-secrets-management-access-locations","view-insights-secrets-management-summary","view-insights-secrets-duplication","view-insights-org-secrets-duplication","view-insights-secrets-management-counts","view-insights-secrets-management-usage","view-insights-secrets-management-project-warnings","create-audit-report","get-audit-reports","get-audit-report","delete-audit-report","create-org-audit-report","get-org-audit-reports","delete-org-audit-report","view-insights-pam-summary","view-insights-pam-session-activity","view-insights-pam-top-actors","view-insights-pam-resource-breakdown","view-insights-pam-rotation-calendar","pam-session-credentials-get","pam-session-start","pam-session-end","pam-session-terminate","pam-session-chunk-upload","pam-session-upload-token-invalid","pam-account-template-create","pam-account-template-update","pam-account-template-delete","pam-folder-create","pam-folder-update","pam-folder-delete","pam-product-member-add","pam-product-member-update","pam-product-member-remove","pam-folder-member-add","pam-folder-member-update","pam-folder-member-remove","pam-account-member-add","pam-account-member-update","pam-account-member-remove","pam-account-access","pam-account-create","pam-account-update","pam-account-delete","pam-account-ssh-ca-create","pam-account-credentials-view","pam-discovery-source-create","pam-discovery-source-update","pam-discovery-source-delete","pam-discovery-scan","pam-discovered-account-import","pam-account-rotate-credentials","pam-account-heartbeat","pam-account-set-rotation-account","pam-web-access-session-ticket-created","pam-access-request-create","pam-access-request-review","pam-access-grant-revoke","pam-approval-config-update","agent-vault-access-bundle-create","agent-vault-access-bundle-update","agent-vault-access-bundle-delete","agent-vault-service-create","agent-vault-service-update","agent-vault-service-delete","agent-vault-variable-create","agent-vault-variable-update","agent-vault-variable-delete","agent-vault-variable-value-view","agent-vault-member-add","agent-vault-member-update","agent-vault-member-remove","agent-vault-access-bundle-member-add","agent-vault-access-bundle-member-remove","agent-vault-session-mint","agent-vault-session-revoke","agent-vault-proxy-register","agent-vault-proxy-token-reissue","agent-vault-proxy-enroll","agent-vault-proxy-update","agent-vault-proxy-revoke","agent-vault-proxy-delete","agent-vault-session-log-settings-update","approval-policy-create","approval-policy-update","approval-policy-delete","approval-policy-list","approval-policy-get","approval-request-get","approval-request-list","approval-request-create","approval-request-approve","approval-request-reject","approval-request-cancel","approval-request-grant-list","approval-request-grant-get","approval-request-grant-revoke","pam-access-policy-bypassed","access-approval-request-create","access-approval-request-review","access-approval-request-revoke","access-approval-request-update","view-audit-logs","create-acme-account","retrieve-acme-account","create-acme-order","finalize-acme-order","download-acme-certificate","respond-to-acme-challenge","pass-acme-challenge","attempt-acme-challenge","fail-acme-challenge","create-dynamic-secret","update-dynamic-secret","delete-dynamic-secret","get-dynamic-secret","list-dynamic-secrets","create-proxied-service","update-proxied-service","delete-proxied-service","sign-agent-proxy-intermediate-ca","create-dynamic-secret-lease","delete-dynamic-secret-lease","renew-dynamic-secret-lease","list-dynamic-secret-leases","get-dynamic-secret-lease","create-pki-discovery","update-pki-discovery","delete-pki-discovery","get-pki-discovery","get-pki-discoveries","trigger-pki-discovery-scan","get-pki-installation","get-pki-installations","update-pki-installation","delete-pki-installation","create-pki-signer","update-pki-signer","delete-pki-signer","get-pki-signer","get-pki-signers","get-pki-signer-public-key","get-pki-signing-operations","get-pki-signing-operation","pki-signer-sign","enable-pki-signer","disable-pki-signer","reissue-pki-signer-certificate","export-pki-signer-certificate","update-pki-signer-approval-policy","pki-signer-request-to-sign","pki-signer-pre-approve-signing","pki-signer-revoke-request","add-pki-signer-member","update-pki-signer-member","remove-pki-signer-member","scep-enrollment","scep-renewal","scep-dynamic-challenge-generated","secret-validation-rule-create","secret-validation-rule-update","secret-validation-rule-delete","external-migration-create","external-migration-update","external-migration-delete","import-vault-secrets","create-oauth-client","update-oauth-client","delete-oauth-client","rotate-oauth-client-secret","oauth-client-authorize","oauth-client-token-exchange","create-email-domain","verify-email-domain","delete-email-domain","gateway-create","gateway-update","gateway-delete","gateway-enrollment-token-create","gateway-enroll","gateway-connect","resource-auth-method-login","resource-auth-method-login-failed","resource-auth-method-create","resource-auth-method-update","resource-auth-method-revoke","relay-create","relay-update","relay-delete","relay-enrollment-token-create","kmip-server-create","kmip-server-update","kmip-server-delete","kmip-server-enrollment-token-create","gateway-pool-create","gateway-pool-update","gateway-pool-delete","gateway-pool-add-member","gateway-pool-remove-member","create-honey-token","update-honey-token","revoke-honey-token","trigger-honey-token","create-project-folder-grant","delete-project-folder-grant","create-secret-folder-access","update-secret-folder-access","delete-secret-folder-access","create-alert","update-alert","delete-alert","test-alert-channel","permission-denied","update-audit-log-settings"]},"maxItems":691}]}]},"in":"query","name":"eventType","required":false},{"schema":{"allOf":[{"anyOf":[{"not":{}},{"type":"string","maxLength":51}]},{"anyOf":[{"not":{}},{"type":"array","items":{"type":"string","enum":["management","authentication","authorization","data-access"]},"maxItems":4}]}]},"in":"query","name":"eventClass","required":false,"description":"Filter by event class, comma-separated for multiple values (management, authentication, authorization, data-access). Combined with eventType, only event types in both are returned. If the selected classes include secret events, the environment, secretPath, and secretKey filters drop every event whose metadata doesn't match, including events that aren't about secrets. If they don't, those filters are ignored."},{"schema":{"type":"string","enum":["web","cli","k8-operator","terraform","other","InfisicalPythonSDK","InfisicalNodeSDK"]},"in":"query","name":"userAgentType","required":false,"description":"Choose which consuming application to export audit logs for."},{"schema":{"type":"string"},"in":"query","name":"eventMetadata","required":false,"description":"Filter by event metadata key-value pairs. Formatted as `key1=value1,key2=value2`, with comma-separation."},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"startDate","required":false,"description":"The date to start the export from."},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"endDate","required":false,"description":"The date to end the export at."},{"schema":{"type":"number","default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th audit log."},{"schema":{"type":"number","maximum":1000,"default":20},"in":"query","name":"limit","required":false,"description":"The number of audit logs to return."},{"schema":{"type":"string"},"in":"query","name":"actor","required":false,"description":"The ID of a specific actor to filter audit logs by. For user actors this is the userId; for identity actors this is the identityId. When filtering non-user actor types, the actorType parameter must also be provided."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"auditLogs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"ipAddress":{"type":"string","nullable":true},"userAgent":{"type":"string","nullable":true},"userAgentType":{"type":"string","nullable":true},"expiresAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"orgId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"projectName":{"type":"string","nullable":true},"event":{"type":"object","properties":{"type":{"type":"string"},"class":{"type":"string","enum":["management","authentication","authorization","data-access"]},"metadata":{}},"required":["type","class"],"additionalProperties":false},"actor":{"type":"object","properties":{"type":{"type":"string"},"metadata":{}},"required":["type"],"additionalProperties":false}},"required":["id","createdAt","updatedAt","event","actor"],"additionalProperties":false}}},"required":["auditLogs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/organization/available-identities":{"get":{"operationId":"listAvailableOrganizationIdentities","tags":["Organization Identity Membership"],"description":"List available identities for org membership","parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th identity."},{"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false,"description":"The number of identities to return."},{"schema":{"type":"string"},"in":"query","name":"identityName","required":false,"description":"The text string that identity membership names will be filtered by."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}}},"required":["identities"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/organization/available-groups":{"get":{"operationId":"listAvailableOrganizationGroups","tags":["Groups"],"description":"List available groups from parent org for linking to sub-organization","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"}},"required":["id","name","slug"],"additionalProperties":false}}},"required":["groups"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/organizations/memberships/groups":{"get":{"operationId":"listOrganizationGroupMemberships","tags":["Groups"],"description":"List organization group memberships","parameters":[{"schema":{"type":"number","minimum":1,"maximum":100,"default":100},"in":"query","name":"limit","required":false},{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"string"},"in":"query","name":"search","required":false},{"schema":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"in":"query","name":"roles","required":false},{"schema":{"type":"string","enum":["name","slug","role"]},"in":"query","name":"orderBy","required":false},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"orderDirection","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groupMemberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"groupId":{"type":"string","format":"uuid"},"group":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug"],"additionalProperties":false},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","role","isTemporary"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","groupId","group","roles","createdAt","updatedAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["groupMemberships","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/organizations/memberships/groups/{groupId}":{"post":{"operationId":"createOrganizationGroupMembership","tags":["Groups"],"description":"Create organization group membership (link group to current org). Sub-org only: links a parent-org group.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[false],"default":false}},"required":["role"],"additionalProperties":false},{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[true]},"temporaryMode":{"type":"string","enum":["relative"]},"temporaryRange":{"type":"string"},"temporaryAccessStartTime":{"type":"string","format":"date-time"}},"required":["role","isTemporary","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}]},"minItems":1}},"required":["roles"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"groupId","required":true,"description":"The ID of the group to link to the current organization"}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groupMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"groupId":{"type":"string","format":"uuid"},"group":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug"],"additionalProperties":false},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","role","isTemporary"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","groupId","group","roles","createdAt","updatedAt"],"additionalProperties":false}},"required":["groupMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getOrganizationGroupMembership","tags":["Groups"],"description":"Get organization group membership by group ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"groupId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groupMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"groupId":{"type":"string","format":"uuid"},"group":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug"],"additionalProperties":false},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","role","isTemporary"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","groupId","group","roles","createdAt","updatedAt"],"additionalProperties":false}},"required":["groupMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateOrganizationGroupMembership","tags":["Groups"],"description":"Update organization group membership roles.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[false],"default":false}},"required":["role"],"additionalProperties":false},{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[true]},"temporaryMode":{"type":"string","enum":["relative"]},"temporaryRange":{"type":"string"},"temporaryAccessStartTime":{"type":"string","format":"date-time"}},"required":["role","isTemporary","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}]},"minItems":1}},"required":["roles"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"groupId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groupMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"groupId":{"type":"string","format":"uuid"},"group":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug"],"additionalProperties":false},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","role","isTemporary"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","groupId","group","roles","createdAt","updatedAt"],"additionalProperties":false}},"required":["groupMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteOrganizationGroupMembership","tags":["Groups"],"description":"Unlink a group from the current organization. Only applicable in sub-organizations where the group is linked; cannot be used in the organization that owns the group.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"groupId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groupMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"groupId":{"type":"string","format":"uuid"},"orgId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","groupId","orgId","createdAt","updatedAt"],"additionalProperties":false}},"required":["groupMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/admin/bootstrap":{"post":{"operationId":"adminBootstrap","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","minLength":1},"password":{"type":"string","minLength":1},"organization":{"type":"string","minLength":1}},"required":["email","password","organization"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"user":{"type":"object","properties":{"username":{"type":"string"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"id":{"type":"string","format":"uuid"},"superAdmin":{"type":"boolean","nullable":true}},"required":["username","id"],"additionalProperties":false},"organization":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"}},"required":["id","name","slug"],"additionalProperties":false},"identity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"credentials":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"],"additionalProperties":false}},"required":["id","name","credentials"],"additionalProperties":false}},"required":["message","user","organization","identity"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/secret-imports":{"post":{"tags":["Secret Imports"],"description":"Create secret imports","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"workspaceId":{"type":"string","description":"The ID of the project you are working in."},"environment":{"type":"string","description":"The slug of the environment to import into."},"path":{"type":"string","default":"/","description":"The path to import into."},"import":{"type":"object","properties":{"environment":{"type":"string","description":"The slug of the environment to import from."},"path":{"type":"string","description":"The path to import from."}},"required":["environment","path"],"additionalProperties":false},"isReplication":{"type":"boolean","default":false,"description":"When true, secrets from the source will be automatically sent to the destination. If approval policies exist at the destination, the secrets will be sent as approval requests instead of being applied immediately."}},"required":["workspaceId","environment","import"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"secretImport":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version":{"type":"number","default":1,"nullable":true},"importPath":{"type":"string"},"position":{"type":"number"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"folderId":{"type":"string","format":"uuid"},"isReplication":{"type":"boolean","default":false,"nullable":true},"isReplicationSuccess":{"type":"boolean","nullable":true},"replicationStatus":{"type":"string","nullable":true},"lastReplicated":{"type":"string","format":"date-time","nullable":true},"isReserved":{"type":"boolean","default":false,"nullable":true},"importEnv":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"id":{"type":"string"}},"required":["name","slug","id"],"additionalProperties":false}},"required":["id","importPath","position","createdAt","updatedAt","folderId","importEnv"],"additionalProperties":false}},"required":["message","secretImport"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"tags":["Secret Imports"],"description":"Get secret imports","parameters":[{"schema":{"type":"string"},"in":"query","name":"workspaceId","required":true,"description":"The ID of the project to list secret imports from."},{"schema":{"type":"string"},"in":"query","name":"environment","required":true,"description":"The slug of the environment to list secret imports from."},{"schema":{"type":"string","default":"/"},"in":"query","name":"path","required":false,"description":"The path to list secret imports from."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"secretImports":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version":{"type":"number","default":1,"nullable":true},"importPath":{"type":"string"},"position":{"type":"number"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"folderId":{"type":"string","format":"uuid"},"isReplication":{"type":"boolean","default":false,"nullable":true},"isReplicationSuccess":{"type":"boolean","nullable":true},"replicationStatus":{"type":"string","nullable":true},"lastReplicated":{"type":"string","format":"date-time","nullable":true},"isReserved":{"type":"boolean","default":false,"nullable":true},"importEnv":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"id":{"type":"string"}},"required":["name","slug","id"],"additionalProperties":false}},"required":["id","importPath","position","createdAt","updatedAt","folderId","importEnv"],"additionalProperties":false}}},"required":["message","secretImports"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/secret-imports/{secretImportId}":{"patch":{"tags":["Secret Imports"],"description":"Update secret imports","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"workspaceId":{"type":"string","description":"The ID of the project where the secret import is located."},"environment":{"type":"string","description":"The slug of the environment where the secret import is located."},"path":{"type":"string","default":"/","description":"The path of the secret import to update."},"import":{"type":"object","properties":{"environment":{"type":"string","description":"The new environment slug to import from."},"path":{"type":"string","description":"The new path to import from."},"position":{"type":"number","description":"The new position of the secret import. The lowest number will be displayed as the first import."}},"additionalProperties":false}},"required":["workspaceId","environment","import"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"secretImportId","required":true,"description":"The ID of the secret import to update."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"secretImport":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version":{"type":"number","default":1,"nullable":true},"importPath":{"type":"string"},"position":{"type":"number"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"folderId":{"type":"string","format":"uuid"},"isReplication":{"type":"boolean","default":false,"nullable":true},"isReplicationSuccess":{"type":"boolean","nullable":true},"replicationStatus":{"type":"string","nullable":true},"lastReplicated":{"type":"string","format":"date-time","nullable":true},"isReserved":{"type":"boolean","default":false,"nullable":true},"importEnv":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"id":{"type":"string"}},"required":["name","slug","id"],"additionalProperties":false}},"required":["id","importPath","position","createdAt","updatedAt","folderId","importEnv"],"additionalProperties":false}},"required":["message","secretImport"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["Secret Imports"],"description":"Delete secret imports","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"workspaceId":{"type":"string","description":"The ID of the project to delete the secret import from."},"environment":{"type":"string","description":"The slug of the environment where the secret import is located."},"path":{"type":"string","default":"/","description":"The path of the secret import to delete."}},"required":["workspaceId","environment"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"secretImportId","required":true,"description":"The ID of the secret import to delete."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"secretImport":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version":{"type":"number","default":1,"nullable":true},"importPath":{"type":"string"},"position":{"type":"number"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"folderId":{"type":"string","format":"uuid"},"isReplication":{"type":"boolean","default":false,"nullable":true},"isReplicationSuccess":{"type":"boolean","nullable":true},"replicationStatus":{"type":"string","nullable":true},"lastReplicated":{"type":"string","format":"date-time","nullable":true},"isReserved":{"type":"boolean","default":false,"nullable":true},"importEnv":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"id":{"type":"string"}},"required":["name","slug","id"],"additionalProperties":false}},"required":["id","importPath","position","createdAt","updatedAt","folderId","importEnv"],"additionalProperties":false}},"required":["message","secretImport"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"tags":["Secret Imports"],"description":"Get single secret import","parameters":[{"schema":{"type":"string"},"in":"path","name":"secretImportId","required":true,"description":"The ID of the secret import to fetch."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"secretImport":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version":{"type":"number","default":1,"nullable":true},"importPath":{"type":"string"},"position":{"type":"number"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"folderId":{"type":"string","format":"uuid"},"isReplication":{"type":"boolean","default":false,"nullable":true},"isReplicationSuccess":{"type":"boolean","nullable":true},"replicationStatus":{"type":"string","nullable":true},"lastReplicated":{"type":"string","format":"date-time","nullable":true},"isReserved":{"type":"boolean","default":false,"nullable":true},"environment":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"}},"required":["id","name","slug"],"additionalProperties":false},"projectId":{"type":"string"},"importEnv":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"id":{"type":"string"}},"required":["name","slug","id"],"additionalProperties":false},"secretPath":{"type":"string"}},"required":["id","importPath","position","createdAt","updatedAt","folderId","environment","projectId","importEnv","secretPath"],"additionalProperties":false}},"required":["secretImport"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/secret-imports/secrets/raw":{"get":{"tags":["Secret Imports"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"workspaceId","required":true},{"schema":{"type":"string"},"in":"query","name":"environment","required":true},{"schema":{"type":"string","default":"/"},"in":"query","name":"path","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"secrets":{"type":"array","items":{"type":"object","properties":{"secretPath":{"type":"string"},"environment":{"type":"string"},"environmentInfo":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"}},"required":["id","name","slug"],"additionalProperties":false},"folderId":{"type":"string"},"secrets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"_id":{"type":"string"},"workspace":{"type":"string"},"environment":{"type":"string"},"version":{"type":"number"},"type":{"type":"string"},"secretKey":{"type":"string"},"secretValue":{"type":"string"},"secretComment":{"type":"string"},"secretReminderNote":{"type":"string","nullable":true},"secretReminderRepeatDays":{"type":"number","nullable":true},"skipMultilineEncoding":{"type":"boolean","default":false,"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"actor":{"type":"object","properties":{"actorId":{"type":"string","nullable":true},"actorType":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"membershipId":{"type":"string","nullable":true},"groupId":{"type":"string","nullable":true}},"additionalProperties":false,"nullable":true},"isRotatedSecret":{"type":"boolean"},"rotationId":{"type":"string","format":"uuid","nullable":true}},"required":["id","_id","workspace","environment","version","type","secretKey","secretValue","secretComment","createdAt","updatedAt"],"additionalProperties":false}}},"required":["secretPath","environment","environmentInfo","secrets"],"additionalProperties":false}}},"required":["secrets"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/folders":{"post":{"tags":["Folders"],"description":"Create folders","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"workspaceId":{"type":"string","description":"The ID of the project to create the folder in."},"environment":{"type":"string","description":"The slug of the environment to create the folder in."},"name":{"type":"string","description":"The name of the folder to create."},"path":{"type":"string","default":"/","description":"The path of the folder to create."},"directory":{"type":"string","default":"/","description":"The directory of the folder to create. (Deprecated in favor of path)"},"description":{"type":"string","nullable":true,"description":"An optional description label for the folder."}},"required":["workspaceId","environment","name"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"folder":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number","default":1,"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"envId":{"type":"string","format":"uuid"},"parentId":{"type":"string","format":"uuid","nullable":true},"isReserved":{"type":"boolean","default":false,"nullable":true},"description":{"type":"string","nullable":true},"lastSecretModified":{"type":"string","format":"date-time","nullable":true},"path":{"type":"string"}},"required":["id","name","createdAt","updatedAt","envId","path"],"additionalProperties":false}},"required":["folder"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"tags":["Folders"],"description":"Get folders","parameters":[{"schema":{"type":"string"},"in":"query","name":"workspaceId","required":true,"description":"The ID of the project to list folders from."},{"schema":{"type":"string"},"in":"query","name":"environment","required":true,"description":"The slug of the environment to list folders from."},{"schema":{"type":"string","format":"date-time"},"in":"query","name":"lastSecretModified","required":false,"description":"The timestamp used to filter folders with secrets modified after the specified date. The format for this timestamp is ISO 8601 (e.g. 2025-04-01T09:41:45-04:00)"},{"schema":{"type":"string"},"in":"query","name":"path","required":false,"description":"The path to list folders from."},{"schema":{"type":"string"},"in":"query","name":"directory","required":false,"description":"The directory to list folders from. (Deprecated in favor of path)"},{"schema":{"anyOf":[{"type":"boolean"},{"type":"string"}],"default":false},"in":"query","name":"recursive","required":false,"description":"Whether or not to fetch all folders from the specified base path, and all of its subdirectories."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"folders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number","default":1,"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"envId":{"type":"string","format":"uuid"},"parentId":{"type":"string","format":"uuid","nullable":true},"isReserved":{"type":"boolean","default":false,"nullable":true},"description":{"type":"string","nullable":true},"lastSecretModified":{"type":"string","format":"date-time","nullable":true},"relativePath":{"type":"string"}},"required":["id","name","createdAt","updatedAt","envId"],"additionalProperties":false}}},"required":["folders"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/folders/{folderId}":{"patch":{"tags":["Folders"],"description":"Update folder","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"workspaceId":{"type":"string","description":"The ID of the project where the folder is located."},"environment":{"type":"string","description":"The slug of the environment where the folder is located."},"name":{"type":"string","description":"The new name of the folder."},"path":{"type":"string","default":"/","description":"The path of the folder to update."},"directory":{"type":"string","default":"/","description":"The new directory of the folder to update. (Deprecated in favor of path)"},"description":{"type":"string","nullable":true,"description":"An optional description label for the folder."}},"required":["workspaceId","environment","name"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"folderId","required":true,"description":"The ID of the folder to update."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"folder":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number","default":1,"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"envId":{"type":"string","format":"uuid"},"parentId":{"type":"string","format":"uuid","nullable":true},"isReserved":{"type":"boolean","default":false,"nullable":true},"description":{"type":"string","nullable":true},"lastSecretModified":{"type":"string","format":"date-time","nullable":true},"path":{"type":"string"}},"required":["id","name","createdAt","updatedAt","envId","path"],"additionalProperties":false}},"required":["folder"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/folders/batch":{"patch":{"tags":["Folders"],"description":"Update folders by batch","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectSlug":{"type":"string","description":"The slug of the project where the folder is located."},"folders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the folder to update."},"environment":{"type":"string","description":"The slug of the environment where the folder is located."},"name":{"type":"string","description":"The new name of the folder."},"path":{"type":"string","default":"/","description":"The path of the folder to update."},"description":{"type":"string","nullable":true,"description":"An optional description label for the folder."}},"required":["id","environment","name"],"additionalProperties":false},"minItems":1}},"required":["projectSlug","folders"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"folders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number","default":1,"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"envId":{"type":"string","format":"uuid"},"parentId":{"type":"string","format":"uuid","nullable":true},"isReserved":{"type":"boolean","default":false,"nullable":true},"description":{"type":"string","nullable":true},"lastSecretModified":{"type":"string","format":"date-time","nullable":true}},"required":["id","name","createdAt","updatedAt","envId"],"additionalProperties":false}}},"required":["folders"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/folders/{folderIdOrName}":{"delete":{"tags":["Folders"],"description":"Delete a folder","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"workspaceId":{"type":"string","description":"The ID of the project to delete the folder from."},"environment":{"type":"string","description":"The slug of the environment where the folder is located."},"path":{"type":"string","default":"/","description":"The path of the folder to delete."},"directory":{"type":"string","default":"/","description":"The directory of the folder to delete. (Deprecated in favor of path)"}},"required":["workspaceId","environment"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"folderIdOrName","required":true,"description":"The ID or name of the folder to delete."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"folder":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number","default":1,"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"envId":{"type":"string","format":"uuid"},"parentId":{"type":"string","format":"uuid","nullable":true},"isReserved":{"type":"boolean","default":false,"nullable":true},"description":{"type":"string","nullable":true},"lastSecretModified":{"type":"string","format":"date-time","nullable":true}},"required":["id","name","createdAt","updatedAt","envId"],"additionalProperties":false}},"required":["folder"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/folders/{id}":{"get":{"tags":["Folders"],"description":"Get folder by id","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the folder to get details."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"folder":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"version":{"type":"number","default":1,"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"envId":{"type":"string","format":"uuid"},"parentId":{"type":"string","format":"uuid","nullable":true},"isReserved":{"type":"boolean","default":false,"nullable":true},"description":{"type":"string","nullable":true},"lastSecretModified":{"type":"string","format":"date-time","nullable":true},"environment":{"type":"object","properties":{"envId":{"type":"string"},"envName":{"type":"string"},"envSlug":{"type":"string"}},"required":["envId","envName","envSlug"],"additionalProperties":false},"path":{"type":"string"},"projectId":{"type":"string"}},"required":["id","name","createdAt","updatedAt","envId","environment","path","projectId"],"additionalProperties":false}},"required":["folder"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/workspace/{workspaceId}":{"get":{"tags":["Projects"],"description":"Get project","parameters":[{"schema":{"type":"string"},"in":"path","name":"workspaceId","required":true,"description":"The ID of the project."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workspace":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"defaultProduct":{"type":"string","nullable":true},"slug":{"type":"string"},"autoCapitalization":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"number","default":1},"upgradeStatus":{"type":"string","nullable":true},"pitVersionLimit":{"type":"number","default":10},"kmsCertificateKeyId":{"type":"string","format":"uuid","nullable":true},"kmsSecretManagerKeyId":{"type":"string","format":"uuid","nullable":true},"auditLogsRetentionDays":{"type":"number","nullable":true},"hasDeleteProtection":{"type":"boolean","default":false,"nullable":true},"secretSharing":{"type":"boolean","default":true},"showSnapshotsLegacy":{"type":"boolean","default":false},"secretDetectionIgnoreValues":{"type":"array","items":{"type":"string"},"nullable":true},"enforceEncryptedSecretManagerSecretMetadata":{"type":"boolean","nullable":true},"secretBlindIndexEnabled":{"type":"boolean","default":true},"isLegacyAdditionalPrivilegesEnabled":{"type":"boolean","default":false},"_id":{"type":"string"},"environments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"id":{"type":"string"}},"required":["name","slug","id"],"additionalProperties":false}}},"required":["id","name","type","slug","orgId","createdAt","updatedAt","_id","environments"],"additionalProperties":false}},"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["Projects"],"description":"Delete project","parameters":[{"schema":{"type":"string"},"in":"path","name":"workspaceId","required":true,"description":"The ID of the project to delete."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workspace":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"defaultProduct":{"type":"string","nullable":true},"slug":{"type":"string"},"autoCapitalization":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"number","default":1},"upgradeStatus":{"type":"string","nullable":true},"pitVersionLimit":{"type":"number","default":10},"kmsCertificateKeyId":{"type":"string","format":"uuid","nullable":true},"kmsSecretManagerKeyId":{"type":"string","format":"uuid","nullable":true},"auditLogsRetentionDays":{"type":"number","nullable":true},"hasDeleteProtection":{"type":"boolean","default":false,"nullable":true},"secretSharing":{"type":"boolean","default":true},"showSnapshotsLegacy":{"type":"boolean","default":false},"secretDetectionIgnoreValues":{"type":"array","items":{"type":"string"},"nullable":true},"enforceEncryptedSecretManagerSecretMetadata":{"type":"boolean","nullable":true},"secretBlindIndexEnabled":{"type":"boolean","default":true},"isLegacyAdditionalPrivilegesEnabled":{"type":"boolean","default":false}},"required":["id","name","type","slug","orgId","createdAt","updatedAt"],"additionalProperties":false}},"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["Projects"],"description":"Update project","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":64,"description":"The new name of the project."},"description":{"type":"string","maxLength":1024,"description":"An optional description label for the project."},"autoCapitalization":{"type":"boolean","description":"Disable or enable auto-capitalization for the project."},"hasDeleteProtection":{"type":"boolean","description":"Enable or disable delete protection for the project."},"slug":{"type":"string","maxLength":64,"description":"An optional slug for the project. (must be unique within the organization)"},"secretSharing":{"type":"boolean","description":"Enable or disable secret sharing for the project."},"showSnapshotsLegacy":{"type":"boolean","description":"Enable or disable legacy snapshots for the project."},"defaultProduct":{"type":"string","enum":["secret-manager","cert-manager","kms","secret-scanning","pam","agent-vault"],"description":"The default product in which the project will open"},"secretDetectionIgnoreValues":{"type":"array","items":{"type":"string"},"description":"The list of secret values to ignore for secret detection."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"workspaceId","required":true,"description":"The ID of the project to update."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workspace":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"defaultProduct":{"type":"string","nullable":true},"slug":{"type":"string"},"autoCapitalization":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"number","default":1},"upgradeStatus":{"type":"string","nullable":true},"pitVersionLimit":{"type":"number","default":10},"kmsCertificateKeyId":{"type":"string","format":"uuid","nullable":true},"kmsSecretManagerKeyId":{"type":"string","format":"uuid","nullable":true},"auditLogsRetentionDays":{"type":"number","nullable":true},"hasDeleteProtection":{"type":"boolean","default":false,"nullable":true},"secretSharing":{"type":"boolean","default":true},"showSnapshotsLegacy":{"type":"boolean","default":false},"secretDetectionIgnoreValues":{"type":"array","items":{"type":"string"},"nullable":true},"enforceEncryptedSecretManagerSecretMetadata":{"type":"boolean","nullable":true},"secretBlindIndexEnabled":{"type":"boolean","default":true},"isLegacyAdditionalPrivilegesEnabled":{"type":"boolean","default":false}},"required":["id","name","type","slug","orgId","createdAt","updatedAt"],"additionalProperties":false}},"required":["workspace"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/workspace/{workspaceId}/integrations":{"get":{"tags":["Integrations"],"description":"List integrations for a project.","parameters":[{"schema":{"type":"string"},"in":"path","name":"workspaceId","required":true,"description":"The ID of the project to list integrations for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"integrations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"isActive":{"type":"boolean"},"url":{"type":"string","nullable":true},"app":{"type":"string","nullable":true},"appId":{"type":"string","nullable":true},"targetEnvironment":{"type":"string","nullable":true},"targetEnvironmentId":{"type":"string","nullable":true},"targetService":{"type":"string","nullable":true},"targetServiceId":{"type":"string","nullable":true},"owner":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"scope":{"type":"string","nullable":true},"integration":{"type":"string"},"metadata":{"nullable":true},"integrationAuthId":{"type":"string","format":"uuid"},"envId":{"type":"string","format":"uuid"},"secretPath":{"type":"string","default":"/"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastUsed":{"type":"string","format":"date-time","nullable":true},"isSynced":{"type":"boolean","nullable":true},"syncMessage":{"type":"string","nullable":true},"lastSyncJobId":{"type":"string","nullable":true},"environment":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"}},"required":["id","name","slug"],"additionalProperties":false}},"required":["id","isActive","integration","integrationAuthId","envId","createdAt","updatedAt","environment"],"additionalProperties":false}}},"required":["integrations"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/workspace/{workspaceId}/authorizations":{"get":{"tags":["Integrations"],"description":"List integration auth objects for a workspace.","parameters":[{"schema":{"type":"string"},"in":"path","name":"workspaceId","required":true,"description":"The ID of the project to list integration auths for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"authorizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"integration":{"type":"string"},"teamId":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"namespace":{"type":"string","nullable":true},"accountId":{"type":"string","nullable":true},"metadata":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","integration","createdAt","updatedAt"],"additionalProperties":false}}},"required":["authorizations"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/workspace/{workspaceId}/environments/{envId}":{"get":{"tags":["Environments"],"description":"Get Environment","parameters":[{"schema":{"type":"string"},"in":"path","name":"workspaceId","required":true,"description":"The ID of the project the environment belongs to."},{"schema":{"type":"string"},"in":"path","name":"envId","required":true,"description":"The ID of the environment to fetch."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"environment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"position":{"type":"number"},"projectId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deleteAfter":{"type":"string","format":"date-time","nullable":true},"softDeletedAt":{"type":"string","format":"date-time","nullable":true},"deletedByUserId":{"type":"string","format":"uuid","nullable":true},"deletedByIdentityId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","position","projectId","createdAt","updatedAt"],"additionalProperties":false}},"required":["environment"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/workspace/environments/{envId}":{"get":{"tags":["Environments"],"description":"Get Environment by ID","parameters":[{"schema":{"type":"string"},"in":"path","name":"envId","required":true,"description":"The ID of the environment to fetch."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"environment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"position":{"type":"number"},"projectId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deleteAfter":{"type":"string","format":"date-time","nullable":true},"softDeletedAt":{"type":"string","format":"date-time","nullable":true},"deletedByUserId":{"type":"string","format":"uuid","nullable":true},"deletedByIdentityId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","position","projectId","createdAt","updatedAt"],"additionalProperties":false}},"required":["environment"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/workspace/{workspaceId}/environments":{"post":{"tags":["Environments"],"description":"Create environment","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the environment to create."},"position":{"type":"number","minimum":1,"description":"The position of the environment. The lowest number will be displayed as the first environment."},"slug":{"type":"string","minLength":1,"maxLength":64,"description":"The slug of the environment to create."}},"required":["name","slug"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"workspaceId","required":true,"description":"The ID of the project to create the environment in."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"workspace":{"type":"string"},"environment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"position":{"type":"number"},"projectId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deleteAfter":{"type":"string","format":"date-time","nullable":true},"softDeletedAt":{"type":"string","format":"date-time","nullable":true},"deletedByUserId":{"type":"string","format":"uuid","nullable":true},"deletedByIdentityId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","position","projectId","createdAt","updatedAt"],"additionalProperties":false}},"required":["message","workspace","environment"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/workspace/{workspaceId}/environments/{id}":{"patch":{"tags":["Environments"],"description":"Update environment","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":64,"description":"The new slug of the environment."},"name":{"type":"string","minLength":1,"maxLength":255,"description":"The new name of the environment."},"position":{"type":"number","description":"The new position of the environment. The lowest number will be displayed as the first environment."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"workspaceId","required":true,"description":"The ID of the project to update the environment in."},{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the environment to update."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"workspace":{"type":"string"},"environment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"position":{"type":"number"},"projectId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deleteAfter":{"type":"string","format":"date-time","nullable":true},"softDeletedAt":{"type":"string","format":"date-time","nullable":true},"deletedByUserId":{"type":"string","format":"uuid","nullable":true},"deletedByIdentityId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","position","projectId","createdAt","updatedAt"],"additionalProperties":false}},"required":["message","workspace","environment"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["Environments"],"description":"Delete environment","parameters":[{"schema":{"type":"string"},"in":"path","name":"workspaceId","required":true,"description":"The ID of the project to delete the environment from."},{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the environment to delete."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"workspace":{"type":"string"},"environment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"position":{"type":"number"},"projectId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deleteAfter":{"type":"string","format":"date-time","nullable":true},"softDeletedAt":{"type":"string","format":"date-time","nullable":true},"deletedByUserId":{"type":"string","format":"uuid","nullable":true},"deletedByIdentityId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","position","projectId","createdAt","updatedAt"],"additionalProperties":false}},"required":["message","workspace","environment"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/workspace/{workspaceId}/memberships":{"get":{"tags":["Project Users"],"description":"Return project user memberships","parameters":[{"schema":{"type":"string"},"in":"path","name":"workspaceId","required":true,"description":"The ID of the project to get memberships from."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userId":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"user":{"type":"object","properties":{"username":{"type":"string"},"email":{"type":"string","nullable":true},"isEmailVerified":{"type":"boolean","default":false,"nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"authMethods":{"type":"array","items":{"type":"string"},"nullable":true},"id":{"type":"string","format":"uuid"},"publicKey":{"type":"string","nullable":true}},"required":["username","id"],"additionalProperties":false},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true}},"required":["id","role","isTemporary"],"additionalProperties":false}}},"required":["id","createdAt","userId","projectId","user","roles"],"additionalProperties":false}}},"required":["memberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/workspace/{workspaceId}/memberships/details":{"post":{"tags":["Project Users"],"description":"Return project user memberships","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","minLength":1,"description":"The username to get project membership of. Email is the default username."}},"required":["username"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"workspaceId","required":true,"description":"The ID of the project to get memberships from."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"userId":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"user":{"type":"object","properties":{"username":{"type":"string"},"email":{"type":"string","nullable":true},"isEmailVerified":{"type":"boolean","default":false,"nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"authMethods":{"type":"array","items":{"type":"string"},"nullable":true},"id":{"type":"string","format":"uuid"},"publicKey":{"type":"string","nullable":true}},"required":["username","id"],"additionalProperties":false},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true}},"required":["id","role","isTemporary"],"additionalProperties":false}}},"required":["id","userId","projectId","user","roles"],"additionalProperties":false}},"required":["membership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/workspace/{workspaceId}/memberships/{membershipId}":{"patch":{"tags":["Project Users"],"description":"Update project user membership","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[false],"default":false}},"required":["role"],"additionalProperties":false},{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[true]},"temporaryMode":{"type":"string","enum":["relative"]},"temporaryRange":{"type":"string"},"temporaryAccessStartTime":{"type":"string","format":"date-time"}},"required":["role","isTemporary","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}]},"minItems":1,"description":"A list of roles to update the membership to."}},"required":["roles"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"workspaceId","required":true,"description":"The ID of the project to update the membership for."},{"schema":{"type":"string"},"in":"path","name":"membershipId","required":true,"description":"The ID of the membership to update."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string"},"projectMembershipId":{"type":"string","format":"uuid"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"isTemporary":{"type":"boolean","default":false},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","role","projectMembershipId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["roles"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/workspace/{projectId}/tags":{"get":{"tags":["Folders"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to list tags from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workspaceTags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"color":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string"},"createdByActorType":{"type":"string","default":"user"}},"required":["id","slug","createdAt","updatedAt","projectId"],"additionalProperties":false}}},"required":["workspaceTags"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["Folders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":64,"description":"The slug of the tag to create."},"color":{"type":"string","description":"The color of the tag to create."}},"required":["slug","color"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to create the tag in."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workspaceTag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"color":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string"},"createdByActorType":{"type":"string","default":"user"}},"required":["id","slug","createdAt","updatedAt","projectId"],"additionalProperties":false}},"required":["workspaceTag"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/workspace/{projectId}/tags/{tagId}":{"get":{"tags":["Folders"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to get tags from."},{"schema":{"type":"string"},"in":"path","name":"tagId","required":true,"description":"The ID of the tag to get details."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workspaceTag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"color":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string"},"createdByActorType":{"type":"string","default":"user"},"name":{"type":"string"}},"required":["id","slug","createdAt","updatedAt","projectId","name"],"additionalProperties":false}},"required":["workspaceTag"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["Folders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":64,"description":"The slug of the tag to update."},"color":{"type":"string","description":"The color of the tag to update."}},"required":["slug","color"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to update the tag in."},{"schema":{"type":"string"},"in":"path","name":"tagId","required":true,"description":"The ID of the tag to get details."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workspaceTag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"color":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string"},"createdByActorType":{"type":"string","default":"user"}},"required":["id","slug","createdAt","updatedAt","projectId"],"additionalProperties":false}},"required":["workspaceTag"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["Folders"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to delete the tag from."},{"schema":{"type":"string"},"in":"path","name":"tagId","required":true,"description":"The ID of the tag to delete."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workspaceTag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"color":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string"},"createdByActorType":{"type":"string","default":"user"}},"required":["id","slug","createdAt","updatedAt","projectId"],"additionalProperties":false}},"required":["workspaceTag"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/workspace/{projectId}/tags/slug/{tagSlug}":{"get":{"tags":["Folders"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to get tags from."},{"schema":{"type":"string"},"in":"path","name":"tagSlug","required":true,"description":"The slug of the tag to get details."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"workspaceTag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"color":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string"},"createdByActorType":{"type":"string","default":"user"},"name":{"type":"string"}},"required":["id","slug","createdAt","updatedAt","projectId","name"],"additionalProperties":false}},"required":["workspaceTag"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects":{"post":{"operationId":"createProject","tags":["Projects"],"description":"Create a new project","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectName":{"type":"string","maxLength":64,"description":"The name of the project to create."},"projectDescription":{"type":"string","maxLength":1024,"description":"An optional description label for the project."},"slug":{"type":"string","minLength":5,"maxLength":64,"description":"An optional slug for the project."},"kmsKeyId":{"type":"string"},"template":{"type":"string","minLength":1,"maxLength":64,"default":"default","description":"The name of the project template, if specified, to apply to this project."},"type":{"type":"string","enum":["secret-manager","cert-manager","kms","secret-scanning","pam","agent-vault"],"default":"secret-manager"},"shouldCreateDefaultEnvs":{"type":"boolean","default":true},"hasDeleteProtection":{"type":"boolean","default":false}},"required":["projectName"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"project":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"defaultProduct":{"type":"string","nullable":true},"slug":{"type":"string"},"autoCapitalization":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"number","default":1},"upgradeStatus":{"type":"string","nullable":true},"pitVersionLimit":{"type":"number","default":10},"kmsCertificateKeyId":{"type":"string","format":"uuid","nullable":true},"kmsSecretManagerKeyId":{"type":"string","format":"uuid","nullable":true},"auditLogsRetentionDays":{"type":"number","nullable":true},"hasDeleteProtection":{"type":"boolean","default":false,"nullable":true},"secretSharing":{"type":"boolean","default":true},"showSnapshotsLegacy":{"type":"boolean","default":false},"secretDetectionIgnoreValues":{"type":"array","items":{"type":"string"},"nullable":true},"enforceEncryptedSecretManagerSecretMetadata":{"type":"boolean","nullable":true},"secretBlindIndexEnabled":{"type":"boolean","default":true},"isLegacyAdditionalPrivilegesEnabled":{"type":"boolean","default":false},"_id":{"type":"string"},"environments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"id":{"type":"string"}},"required":["name","slug","id"],"additionalProperties":false}},"deletedEnvironments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"deleteAfter":{"type":"string","format":"date-time"},"softDeletedAt":{"type":"string","format":"date-time"},"deletedBy":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string"},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true}},"required":["type","id","email","username","firstName","lastName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["identity"]},"id":{"type":"string"},"name":{"type":"string"}},"required":["type","id","name"],"additionalProperties":false}],"nullable":true}},"required":["id","name","slug","deleteAfter","softDeletedAt","deletedBy"],"additionalProperties":false}}},"required":["id","name","type","slug","orgId","createdAt","updatedAt","_id","environments","deletedEnvironments"],"additionalProperties":false}},"required":["project"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listProjects","tags":["Projects"],"description":"List projects","parameters":[{"schema":{"type":"string","enum":["true","false"],"default":"false"},"in":"query","name":"includeRoles","required":false},{"schema":{"type":"string","enum":["secret-manager","cert-manager","kms","secret-scanning","pam","agent-vault"]},"in":"query","name":"type","required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projects":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"defaultProduct":{"type":"string","nullable":true},"slug":{"type":"string"},"autoCapitalization":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"number","default":1},"upgradeStatus":{"type":"string","nullable":true},"pitVersionLimit":{"type":"number","default":10},"kmsCertificateKeyId":{"type":"string","format":"uuid","nullable":true},"kmsSecretManagerKeyId":{"type":"string","format":"uuid","nullable":true},"auditLogsRetentionDays":{"type":"number","nullable":true},"hasDeleteProtection":{"type":"boolean","default":false,"nullable":true},"secretSharing":{"type":"boolean","default":true},"showSnapshotsLegacy":{"type":"boolean","default":false},"secretDetectionIgnoreValues":{"type":"array","items":{"type":"string"},"nullable":true},"enforceEncryptedSecretManagerSecretMetadata":{"type":"boolean","nullable":true},"secretBlindIndexEnabled":{"type":"boolean","default":true},"isLegacyAdditionalPrivilegesEnabled":{"type":"boolean","default":false},"_id":{"type":"string"},"environments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"id":{"type":"string"}},"required":["name","slug","id"],"additionalProperties":false}},"deletedEnvironments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"deleteAfter":{"type":"string","format":"date-time"},"softDeletedAt":{"type":"string","format":"date-time"},"deletedBy":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string"},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true}},"required":["type","id","email","username","firstName","lastName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["identity"]},"id":{"type":"string"},"name":{"type":"string"}},"required":["type","id","name"],"additionalProperties":false}],"nullable":true}},"required":["id","name","slug","deleteAfter","softDeletedAt","deletedBy"],"additionalProperties":false}},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"slug":{"type":"string"},"permissions":{},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"},"version":{"type":"number","default":1}},"required":["id","name","slug","createdAt","updatedAt","projectId"],"additionalProperties":false}}},"required":["id","name","type","slug","orgId","createdAt","updatedAt","_id","environments","deletedEnvironments"],"additionalProperties":false}}},"required":["projects"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}":{"get":{"operationId":"getProjectById","tags":["Projects"],"description":"Get project","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"project":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"defaultProduct":{"type":"string","nullable":true},"slug":{"type":"string"},"autoCapitalization":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"number","default":1},"upgradeStatus":{"type":"string","nullable":true},"pitVersionLimit":{"type":"number","default":10},"kmsCertificateKeyId":{"type":"string","format":"uuid","nullable":true},"kmsSecretManagerKeyId":{"type":"string","format":"uuid","nullable":true},"auditLogsRetentionDays":{"type":"number","nullable":true},"hasDeleteProtection":{"type":"boolean","default":false,"nullable":true},"secretSharing":{"type":"boolean","default":true},"showSnapshotsLegacy":{"type":"boolean","default":false},"secretDetectionIgnoreValues":{"type":"array","items":{"type":"string"},"nullable":true},"enforceEncryptedSecretManagerSecretMetadata":{"type":"boolean","nullable":true},"secretBlindIndexEnabled":{"type":"boolean","default":true},"isLegacyAdditionalPrivilegesEnabled":{"type":"boolean","default":false},"_id":{"type":"string"},"environments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"id":{"type":"string"}},"required":["name","slug","id"],"additionalProperties":false}},"deletedEnvironments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"deleteAfter":{"type":"string","format":"date-time"},"softDeletedAt":{"type":"string","format":"date-time"},"deletedBy":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string"},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true}},"required":["type","id","email","username","firstName","lastName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["identity"]},"id":{"type":"string"},"name":{"type":"string"}},"required":["type","id","name"],"additionalProperties":false}],"nullable":true}},"required":["id","name","slug","deleteAfter","softDeletedAt","deletedBy"],"additionalProperties":false}}},"required":["id","name","type","slug","orgId","createdAt","updatedAt","_id","environments","deletedEnvironments"],"additionalProperties":false}},"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteProject","tags":["Projects"],"description":"Delete project","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to delete."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"project":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"defaultProduct":{"type":"string","nullable":true},"slug":{"type":"string"},"autoCapitalization":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"number","default":1},"upgradeStatus":{"type":"string","nullable":true},"pitVersionLimit":{"type":"number","default":10},"kmsCertificateKeyId":{"type":"string","format":"uuid","nullable":true},"kmsSecretManagerKeyId":{"type":"string","format":"uuid","nullable":true},"auditLogsRetentionDays":{"type":"number","nullable":true},"hasDeleteProtection":{"type":"boolean","default":false,"nullable":true},"secretSharing":{"type":"boolean","default":true},"showSnapshotsLegacy":{"type":"boolean","default":false},"secretDetectionIgnoreValues":{"type":"array","items":{"type":"string"},"nullable":true},"enforceEncryptedSecretManagerSecretMetadata":{"type":"boolean","nullable":true},"secretBlindIndexEnabled":{"type":"boolean","default":true},"isLegacyAdditionalPrivilegesEnabled":{"type":"boolean","default":false}},"required":["id","name","type","slug","orgId","createdAt","updatedAt"],"additionalProperties":false}},"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateProject","tags":["Projects"],"description":"Update project","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":64,"description":"The new name of the project."},"description":{"type":"string","maxLength":1024,"description":"An optional description label for the project."},"autoCapitalization":{"type":"boolean","description":"Disable or enable auto-capitalization for the project."},"hasDeleteProtection":{"type":"boolean","description":"Enable or disable delete protection for the project."},"enforceEncryptedSecretManagerSecretMetadata":{"type":"boolean","description":"Enable or disable enforcement of encrypted secret metadata for the project."},"slug":{"type":"string","maxLength":64,"description":"An optional slug for the project. (must be unique within the organization)"},"secretSharing":{"type":"boolean","description":"Enable or disable secret sharing for the project."},"showSnapshotsLegacy":{"type":"boolean","description":"Enable or disable legacy snapshots for the project."},"secretDetectionIgnoreValues":{"type":"array","items":{"type":"string"},"description":"The list of secret values to ignore for secret detection."},"pitVersionLimit":{"type":"number","minimum":1,"maximum":100},"auditLogsRetentionDays":{"type":"number","minimum":1,"maximum":365,"description":"The number of days to retain audit logs for. Can only be set on self-hosted and dedicated instances, and cannot exceed the retention period included in your plan."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to update."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"project":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"defaultProduct":{"type":"string","nullable":true},"slug":{"type":"string"},"autoCapitalization":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"number","default":1},"upgradeStatus":{"type":"string","nullable":true},"pitVersionLimit":{"type":"number","default":10},"kmsCertificateKeyId":{"type":"string","format":"uuid","nullable":true},"kmsSecretManagerKeyId":{"type":"string","format":"uuid","nullable":true},"auditLogsRetentionDays":{"type":"number","nullable":true},"hasDeleteProtection":{"type":"boolean","default":false,"nullable":true},"secretSharing":{"type":"boolean","default":true},"showSnapshotsLegacy":{"type":"boolean","default":false},"secretDetectionIgnoreValues":{"type":"array","items":{"type":"string"},"nullable":true},"enforceEncryptedSecretManagerSecretMetadata":{"type":"boolean","nullable":true},"secretBlindIndexEnabled":{"type":"boolean","default":true},"isLegacyAdditionalPrivilegesEnabled":{"type":"boolean","default":false}},"required":["id","name","type","slug","orgId","createdAt","updatedAt"],"additionalProperties":false}},"required":["project"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/slug/{slug}":{"get":{"operationId":"getProjectBySlug","tags":["Projects"],"description":"Get project details by slug","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":64},"in":"path","name":"slug","required":true,"description":"The slug of the project to get."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"type":{"type":"string"},"defaultProduct":{"type":"string","nullable":true},"slug":{"type":"string"},"autoCapitalization":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"number","default":1},"upgradeStatus":{"type":"string","nullable":true},"pitVersionLimit":{"type":"number","default":10},"kmsCertificateKeyId":{"type":"string","format":"uuid","nullable":true},"kmsSecretManagerKeyId":{"type":"string","format":"uuid","nullable":true},"auditLogsRetentionDays":{"type":"number","nullable":true},"hasDeleteProtection":{"type":"boolean","default":false,"nullable":true},"secretSharing":{"type":"boolean","default":true},"showSnapshotsLegacy":{"type":"boolean","default":false},"secretDetectionIgnoreValues":{"type":"array","items":{"type":"string"},"nullable":true},"enforceEncryptedSecretManagerSecretMetadata":{"type":"boolean","nullable":true},"secretBlindIndexEnabled":{"type":"boolean","default":true},"isLegacyAdditionalPrivilegesEnabled":{"type":"boolean","default":false},"_id":{"type":"string"},"environments":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"id":{"type":"string"}},"required":["name","slug","id"],"additionalProperties":false}},"deletedEnvironments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"deleteAfter":{"type":"string","format":"date-time"},"softDeletedAt":{"type":"string","format":"date-time"},"deletedBy":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"id":{"type":"string"},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true}},"required":["type","id","email","username","firstName","lastName"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["identity"]},"id":{"type":"string"},"name":{"type":"string"}},"required":["type","id","name"],"additionalProperties":false}],"nullable":true}},"required":["id","name","slug","deleteAfter","softDeletedAt","deletedBy"],"additionalProperties":false}}},"required":["id","name","type","slug","orgId","createdAt","updatedAt","_id","environments","deletedEnvironments"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/audit-log-settings":{"get":{"operationId":"getProjectAuditLogSettings","tags":["Audit Logs"],"description":"Get which audit log event classes the project records","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to get the audit log settings for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"auditLogSettings":{"type":"object","properties":{"eventClasses":{"type":"array","items":{"type":"object","properties":{"eventClass":{"type":"string","enum":["management","authentication","authorization","data-access"],"description":"The audit log event class: management, authentication, data-access, or authorization."},"isEnabled":{"type":"boolean","description":"Whether events of this class are recorded."}},"required":["eventClass","isEnabled"],"additionalProperties":false}},"shouldUseNewPrivilegeSystem":{"type":"boolean","description":"Whether the organization is on the new privilege system. Permission denials (the authorization class) are only recorded on the new privilege system."}},"required":["eventClasses","shouldUseNewPrivilegeSystem"],"additionalProperties":false}},"required":["auditLogSettings"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"put":{"operationId":"updateProjectAuditLogSettings","tags":["Audit Logs"],"description":"Update which audit log event classes the project records. Requires the project admin role.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eventClasses":{"type":"array","items":{"type":"object","properties":{"eventClass":{"type":"string","enum":["management","authentication","authorization","data-access"],"description":"The audit log event class: management, authentication, data-access, or authorization."},"isEnabled":{"type":"boolean","description":"Whether to record events of this class for the project. A project that has never saved a setting uses the default."}},"required":["eventClass","isEnabled"],"additionalProperties":false},"minItems":1,"maxItems":4,"description":"Every event class except management and data-access, each exactly once. The request replaces the current settings. Management and data-access events are always recorded, so a request that includes either class is rejected. The authorization class can only be turned on for organizations on the new privilege system; otherwise the request is rejected."}},"required":["eventClasses"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to update the audit log settings for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"auditLogSettings":{"type":"object","properties":{"eventClasses":{"type":"array","items":{"type":"object","properties":{"eventClass":{"type":"string","enum":["management","authentication","authorization","data-access"],"description":"The audit log event class: management, authentication, data-access, or authorization."},"isEnabled":{"type":"boolean","description":"Whether events of this class are recorded."}},"required":["eventClass","isEnabled"],"additionalProperties":false}},"shouldUseNewPrivilegeSystem":{"type":"boolean","description":"Whether the organization is on the new privilege system. Permission denials (the authorization class) are only recorded on the new privilege system."}},"required":["eventClasses","shouldUseNewPrivilegeSystem"],"additionalProperties":false}},"required":["auditLogSettings"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/integrations":{"get":{"operationId":"listProjectIntegrations","tags":["Integrations"],"description":"List integrations for a project.","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to list integrations for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"integrations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"isActive":{"type":"boolean"},"url":{"type":"string","nullable":true},"app":{"type":"string","nullable":true},"appId":{"type":"string","nullable":true},"targetEnvironment":{"type":"string","nullable":true},"targetEnvironmentId":{"type":"string","nullable":true},"targetService":{"type":"string","nullable":true},"targetServiceId":{"type":"string","nullable":true},"owner":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"scope":{"type":"string","nullable":true},"integration":{"type":"string"},"metadata":{"nullable":true},"integrationAuthId":{"type":"string","format":"uuid"},"envId":{"type":"string","format":"uuid"},"secretPath":{"type":"string","default":"/"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastUsed":{"type":"string","format":"date-time","nullable":true},"isSynced":{"type":"boolean","nullable":true},"syncMessage":{"type":"string","nullable":true},"lastSyncJobId":{"type":"string","nullable":true},"environment":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"}},"required":["id","name","slug"],"additionalProperties":false}},"required":["id","isActive","integration","integrationAuthId","envId","createdAt","updatedAt","environment"],"additionalProperties":false}}},"required":["integrations"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/authorizations":{"get":{"operationId":"listProjectIntegrationAuthorizations","tags":["Integrations"],"description":"List integration auth objects for a project.","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to list integration auths for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"authorizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"integration":{"type":"string"},"teamId":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"namespace":{"type":"string","nullable":true},"accountId":{"type":"string","nullable":true},"metadata":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","integration","createdAt","updatedAt"],"additionalProperties":false}}},"required":["authorizations"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/cas":{"get":{"operationId":"listProjectCertificateAuthorities","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string","enum":["active","pending-certificate"]},"in":"query","name":"status","required":false,"description":"The status of the CA to filter by."},{"schema":{"type":"string"},"in":"query","name":"friendlyName","required":false,"description":"The friendly name of the CA to filter by."},{"schema":{"type":"string"},"in":"query","name":"commonName","required":false,"description":"The common name of the CA to filter by."},{"schema":{"type":"number","minimum":0,"maximum":100,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th CA."},{"schema":{"type":"number","minimum":1,"maximum":100,"default":25},"in":"query","name":"limit","required":false,"description":"The number of CAs to return."},{"schema":{"type":"string"},"in":"path","name":"projectId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"cas":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"},"status":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"parentCaId":{"type":"string","format":"uuid","nullable":true},"type":{"type":"string"},"friendlyName":{"type":"string"},"organization":{"type":"string"},"ou":{"type":"string"},"country":{"type":"string"},"province":{"type":"string"},"locality":{"type":"string"},"commonName":{"type":"string"},"dn":{"type":"string"},"serialNumber":{"type":"string","nullable":true},"maxPathLength":{"type":"number","nullable":true},"keyAlgorithm":{"type":"string"},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string"},"nullable":true},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false},"isOcspEnabled":{"type":"boolean","default":false},"ocspGeneration":{"type":"number","default":0},"requireTemplateForIssuance":{"type":"boolean"},"notAfter":{"type":"string"},"notBefore":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","status","name","type","friendlyName","organization","ou","country","province","locality","commonName","dn","keyAlgorithm"],"additionalProperties":false}}},"required":["cas"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/certificates/search":{"post":{"operationId":"searchProjectCertificates","tags":["PKI Certificates"],"description":"Search and filter certificates within a project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"friendlyName":{"type":"string","description":"The friendly name of the certificate to filter by."},"commonName":{"type":"string","description":"The common name of the certificate to filter by."},"offset":{"type":"number","minimum":0,"default":0,"description":"The offset to start from. If you enter 10, it will start from the 10th certificate."},"limit":{"type":"number","minimum":1,"maximum":100,"default":25,"description":"The number of certificates to return."},"forPkiSync":{"type":"boolean","default":false,"description":"Retrieve only certificates available for PKI sync."},"search":{"type":"string","description":"Search by SAN, CN, certificate ID, or serial number."},"status":{"type":"string","description":"Comma-separated list of certificate statuses to filter by. Supported values are active, renewed, expired and revoked. A certificate superseded by a renewal matches renewed rather than active until it expires or is revoked."},"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Filter by certificate profile IDs."},"fromDate":{"type":"string","format":"date-time","description":"Filter certificates created from this date."},"toDate":{"type":"string","format":"date-time","description":"Filter certificates created until this date."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020}},"required":["key"],"additionalProperties":false},"description":"Filter by metadata key-value pairs. Each entry should have a key (required) and optionally a value to match against."},"extendedKeyUsage":{"type":"string","description":"Filter by extended key usage. Only certificates containing this EKU will be returned (e.g. 'codeSigning', 'serverAuth')."},"keyAlgorithm":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Filter by key algorithm (e.g. 'RSA_2048', 'EC_prime256v1')."},"signatureAlgorithm":{"type":"string","description":"Filter by signature algorithm (e.g. 'RSA-SHA256', 'ECDSA-SHA256')."},"keySizes":{"type":"array","items":{"type":"number"},"description":"Filter by key sizes in bits (e.g. [2048, 4096])."},"caIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Filter by certificate authority IDs."},"enrollmentTypes":{"type":"array","items":{"type":"string"},"description":"Filter by enrollment types (e.g. 'api', 'est', 'acme', 'scep')."},"source":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Filter by certificate source ('issued', 'discovered', 'imported')."},"notAfterFrom":{"type":"string","format":"date-time","description":"Filter certificates expiring on or after this date."},"notAfterTo":{"type":"string","format":"date-time","description":"Filter certificates expiring on or before this date."},"notBeforeFrom":{"type":"string","format":"date-time","description":"Filter certificates issued on or after this date."},"notBeforeTo":{"type":"string","format":"date-time","description":"Filter certificates issued on or before this date."},"applicationId":{"type":"string","format":"uuid","description":"Filter to certificates issued through a specific Application."},"applicationIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Filter to certificates issued through any of the supplied Applications."},"sortBy":{"type":"string","enum":["notAfter","notBefore","createdAt","commonName","keyAlgorithm","status"],"description":"Column to sort by (e.g. 'notAfter', 'notBefore', 'commonName')."},"sortOrder":{"type":"string","enum":["asc","desc"],"description":"Sort direction: 'asc' or 'desc'."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"status":{"type":"string"},"serialNumber":{"type":"string"},"friendlyName":{"type":"string"},"commonName":{"type":"string"},"notBefore":{"type":"string","format":"date-time"},"notAfter":{"type":"string","format":"date-time"},"revokedAt":{"type":"string","format":"date-time","nullable":true},"revocationReason":{"type":"number","nullable":true},"altNames":{"type":"string","nullable":true},"caCertId":{"type":"string","format":"uuid","nullable":true},"certificateTemplateId":{"type":"string","format":"uuid","nullable":true},"keyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"extendedKeyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"projectId":{"type":"string"},"pkiSubscriberId":{"type":"string","format":"uuid","nullable":true},"profileId":{"type":"string","format":"uuid","nullable":true},"renewBeforeDays":{"type":"number","nullable":true},"renewedFromCertificateId":{"type":"string","format":"uuid","nullable":true},"renewedByCertificateId":{"type":"string","format":"uuid","nullable":true},"renewalError":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","nullable":true},"signatureAlgorithm":{"type":"string","nullable":true},"subjectOrganization":{"type":"string","nullable":true},"subjectOrganizationalUnit":{"type":"string","nullable":true},"subjectCountry":{"type":"string","nullable":true},"subjectState":{"type":"string","nullable":true},"subjectLocality":{"type":"string","nullable":true},"fingerprintSha256":{"type":"string","nullable":true},"fingerprintSha1":{"type":"string","nullable":true},"isCA":{"type":"boolean","nullable":true},"pathLength":{"type":"number","nullable":true},"source":{"type":"string","nullable":true},"discoveryMetadata":{"nullable":true},"externalMetadata":{"nullable":true},"applicationId":{"type":"string","format":"uuid","nullable":true},"keySource":{"type":"string","default":"infisical"},"hsmConnectorId":{"type":"string","format":"uuid","nullable":true},"hsmKeyLabel":{"type":"string","nullable":true},"hsmPublicKeySpki":{"nullable":true},"subjectDomainComponents":{"type":"string","nullable":true},"orderId":{"type":"string","format":"uuid","default":"00000000-0000-0000-0000-000000000000"},"customExtensions":{"nullable":true},"hasPrivateKey":{"type":"boolean"},"caName":{"type":"string","nullable":true},"profileName":{"type":"string","nullable":true},"enrollmentType":{"type":"string","nullable":true},"applicationName":{"type":"string","nullable":true}},"required":["id","createdAt","updatedAt","status","serialNumber","friendlyName","commonName","notBefore","notAfter","projectId","hasPrivateKey"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["certificates","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/pki-alerts":{"get":{"operationId":"listProjectPkiAlerts","tags":["PKI Alerting"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"alerts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"},"pkiCollectionId":{"type":"string","format":"uuid"},"name":{"type":"string"},"alertBeforeDays":{"type":"number"},"recipientEmails":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","pkiCollectionId","name","alertBeforeDays","recipientEmails"],"additionalProperties":false}}},"required":["alerts"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/pki-collections":{"get":{"operationId":"listProjectPkiCollections","tags":["PKI Certificate Collections"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"collections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","name","description"],"additionalProperties":false}}},"required":["collections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/pki-subscribers":{"get":{"operationId":"listProjectPkiSubscribers","tags":["PKI Subscribers"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to list PKI subscribers for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"subscribers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"caId":{"type":"string","format":"uuid","nullable":true},"name":{"type":"string"},"commonName":{"type":"string"},"status":{"type":"string"},"subjectAlternativeNames":{"type":"array","items":{"type":"string"}},"ttl":{"type":"string","nullable":true},"keyUsages":{"type":"array","items":{"type":"string"}},"extendedKeyUsages":{"type":"array","items":{"type":"string"}},"lastOperationStatus":{"type":"string","nullable":true},"lastOperationMessage":{"type":"string","nullable":true},"lastOperationAt":{"type":"string","format":"date-time","nullable":true},"enableAutoRenewal":{"type":"boolean","default":false},"autoRenewalPeriodInDays":{"type":"number","nullable":true},"lastAutoRenewAt":{"type":"string","format":"date-time","nullable":true},"properties":{"nullable":true},"supportsImmediateCertIssuance":{"type":"boolean"}},"required":["id","projectId","name","commonName","status","subjectAlternativeNames","keyUsages","extendedKeyUsages"],"additionalProperties":false}}},"required":["subscribers"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/certificate-templates":{"get":{"operationId":"listProjectCertificateTemplates","tags":["PKI Certificate Templates"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateTemplates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid"},"name":{"type":"string"},"commonName":{"type":"string"},"subjectAlternativeName":{"type":"string"},"pkiCollectionId":{"type":"string","format":"uuid","nullable":true},"ttl":{"type":"string"},"keyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"extendedKeyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"projectId":{"type":"string"},"caName":{"type":"string"}},"required":["id","caId","name","commonName","subjectAlternativeName","ttl","projectId","caName"],"additionalProperties":false}}},"required":["certificateTemplates"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/memberships":{"get":{"tags":["Project Users"],"description":"Return project user memberships","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to get memberships from."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userId":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"user":{"type":"object","properties":{"username":{"type":"string"},"email":{"type":"string","nullable":true},"isEmailVerified":{"type":"boolean","default":false,"nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"authMethods":{"type":"array","items":{"type":"string"},"nullable":true},"id":{"type":"string","format":"uuid"},"publicKey":{"type":"string","nullable":true}},"required":["username","id"],"additionalProperties":false},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true}},"required":["id","role","isTemporary"],"additionalProperties":false}}},"required":["id","createdAt","userId","projectId","user","roles"],"additionalProperties":false}}},"required":["memberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"inviteProjectMembers","tags":["Project Users"],"description":"Invite members to project","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"default":[],"description":"A list of organization member emails to invite to the project."},"usernames":{"type":"array","items":{"type":"string"},"default":[],"description":"A list of usernames to invite to the project."},"roleSlugs":{"type":"array","items":{"type":"string"},"minItems":1,"description":"A list of role slugs to assign to the newly created project membership. If nothing is provided, it will default to the Member role."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to invite the member to."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"userId":{"type":"string","format":"uuid"},"projectId":{"type":"string"}},"required":["id","createdAt","updatedAt","userId","projectId"],"additionalProperties":false}}},"required":["memberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removeProjectMembers","tags":["Project Users"],"description":"Remove members from project","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"default":[],"description":"A list of organization member emails to remove from the project."},"usernames":{"type":"array","items":{"type":"string"},"default":[],"description":"A list of usernames to remove from the project."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to remove the member from."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"userId":{"type":"string","format":"uuid"},"projectId":{"type":"string"}},"required":["id","createdAt","updatedAt","userId","projectId"],"additionalProperties":false}}},"required":["memberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/memberships/details":{"post":{"operationId":"getProjectMembershipByUsername","tags":["Project Users"],"description":"Return project user memberships","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string","minLength":1,"description":"The username to get project membership of. Email is the default username."}},"required":["username"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"projectId","required":true,"description":"The ID of the project to get memberships from."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"userId":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"user":{"type":"object","properties":{"username":{"type":"string"},"email":{"type":"string","nullable":true},"isEmailVerified":{"type":"boolean","default":false,"nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"authMethods":{"type":"array","items":{"type":"string"},"nullable":true},"id":{"type":"string","format":"uuid"},"publicKey":{"type":"string","nullable":true}},"required":["username","id"],"additionalProperties":false},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true}},"required":["id","role","isTemporary"],"additionalProperties":false}}},"required":["id","userId","projectId","user","roles"],"additionalProperties":false}},"required":["membership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/memberships/{membershipId}":{"patch":{"operationId":"updateProjectMembership","tags":["Project Users"],"description":"Update project user membership","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[false],"default":false}},"required":["role"],"additionalProperties":false},{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[true]},"temporaryMode":{"type":"string","enum":["relative"]},"temporaryRange":{"type":"string"},"temporaryAccessStartTime":{"type":"string","format":"date-time"}},"required":["role","isTemporary","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}]},"minItems":1,"description":"A list of roles to update the membership to."}},"required":["roles"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to update the membership for."},{"schema":{"type":"string"},"in":"path","name":"membershipId","required":true,"description":"The ID of the membership to update."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string"},"projectMembershipId":{"type":"string","format":"uuid"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"isTemporary":{"type":"boolean","default":false},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","role","projectMembershipId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["roles"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/identities":{"post":{"operationId":"createProjectMachineIdentity","tags":["Identities"],"description":"Create an identity in a project","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The name of the identity to create."},"hasDeleteProtection":{"type":"boolean","default":false,"description":"Prevents deletion of the identity when enabled."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["key","value"],"additionalProperties":false},"description":"An optional array of key-value pairs to attach to the identity."},"roles":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"role":{"type":"string","minLength":1},"isTemporary":{"type":"boolean","enum":[false],"default":false}},"required":["role"],"additionalProperties":false},{"type":"object","properties":{"role":{"type":"string","minLength":1},"isTemporary":{"type":"boolean","enum":[true]},"temporaryMode":{"type":"string","enum":["relative"]},"temporaryRange":{"type":"string"},"temporaryAccessStartTime":{"type":"string","format":"date-time"}},"required":["role","isTemporary","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}]}}},"required":["name"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to create the identity in"}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"orgId":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"hasDeleteProtection":{"type":"boolean","default":false},"activeLockoutAuthMethods":{"type":"array","items":{"type":"string"}},"authMethods":{"type":"array","items":{"type":"string"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"}},"required":["key","value","id"],"additionalProperties":false}}},"required":["id","name","orgId","createdAt","updatedAt"],"additionalProperties":false}},"required":["identity"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listProjectMachineIdentities","tags":["Identities"],"description":"List identities in a project","parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th identity."},{"schema":{"type":"number","minimum":1,"maximum":1000,"default":20},"in":"query","name":"limit","required":false,"description":"The number of identities to return."},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"The text string that identity names will be filtered by."},{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project"}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"orgId":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"hasDeleteProtection":{"type":"boolean","default":false},"activeLockoutAuthMethods":{"type":"array","items":{"type":"string"}},"authMethods":{"type":"array","items":{"type":"string"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"}},"required":["key","value","id"],"additionalProperties":false}}},"required":["id","name","orgId","createdAt","updatedAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["identities","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/identities/{identityId}":{"patch":{"operationId":"updateProjectMachineIdentity","tags":["Identities"],"description":"Update an identity in a project","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The new name of the identity."},"hasDeleteProtection":{"type":"boolean","description":"Prevents deletion of the identity when enabled."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["key","value"],"additionalProperties":false},"description":"An optional array of key-value pairs to attach to the identity."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project"},{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"orgId":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"hasDeleteProtection":{"type":"boolean","default":false},"activeLockoutAuthMethods":{"type":"array","items":{"type":"string"}},"authMethods":{"type":"array","items":{"type":"string"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"}},"required":["key","value","id"],"additionalProperties":false}}},"required":["id","name","orgId","createdAt","updatedAt"],"additionalProperties":false}},"required":["identity"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteProjectMachineIdentity","tags":["Identities"],"description":"Delete an identity from a project","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project"},{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to delete."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"orgId":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"hasDeleteProtection":{"type":"boolean","default":false},"activeLockoutAuthMethods":{"type":"array","items":{"type":"string"}},"authMethods":{"type":"array","items":{"type":"string"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"}},"required":["key","value","id"],"additionalProperties":false}}},"required":["id","name","orgId","createdAt","updatedAt"],"additionalProperties":false}},"required":["identity"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getProjectMachineIdentityById","tags":["Identities"],"description":"Get an identity by ID in a project","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project"},{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to get details."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"orgId":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"hasDeleteProtection":{"type":"boolean","default":false},"activeLockoutAuthMethods":{"type":"array","items":{"type":"string"}},"authMethods":{"type":"array","items":{"type":"string"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"id":{"type":"string"}},"required":["key","value","id"],"additionalProperties":false}}},"required":["id","name","orgId","createdAt","updatedAt"],"additionalProperties":false}},"required":["identity"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/environments/{envId}":{"get":{"operationId":"getEnvironmentById","tags":["Environments"],"description":"Get Environment by ID","parameters":[{"schema":{"type":"string"},"in":"path","name":"envId","required":true,"description":"The ID of the environment to fetch."},{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project the environment belongs to."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"environment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"position":{"type":"number"},"projectId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deleteAfter":{"type":"string","format":"date-time","nullable":true},"softDeletedAt":{"type":"string","format":"date-time","nullable":true},"deletedByUserId":{"type":"string","format":"uuid","nullable":true},"deletedByIdentityId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","position","projectId","createdAt","updatedAt"],"additionalProperties":false}},"required":["environment"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/environments/slug/{envSlug}":{"get":{"operationId":"getEnvironmentBySlug","tags":["Environments"],"description":"Get Environment by slug","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project the environment belongs to."},{"schema":{"type":"string","minLength":1,"maxLength":64},"in":"path","name":"envSlug","required":true,"description":"The slug of the environment to fetch."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"environment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"position":{"type":"number"},"projectId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deleteAfter":{"type":"string","format":"date-time","nullable":true},"softDeletedAt":{"type":"string","format":"date-time","nullable":true},"deletedByUserId":{"type":"string","format":"uuid","nullable":true},"deletedByIdentityId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","position","projectId","createdAt","updatedAt"],"additionalProperties":false}},"required":["environment"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/environments":{"post":{"operationId":"createEnvironment","tags":["Environments"],"description":"Create environment","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the environment to create."},"position":{"type":"number","minimum":1,"description":"The position of the environment. The lowest number will be displayed as the first environment."},"slug":{"type":"string","minLength":1,"maxLength":64,"description":"The slug of the environment to create."}},"required":["name","slug"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to create the environment in."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"projectId":{"type":"string"},"environment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"position":{"type":"number"},"projectId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deleteAfter":{"type":"string","format":"date-time","nullable":true},"softDeletedAt":{"type":"string","format":"date-time","nullable":true},"deletedByUserId":{"type":"string","format":"uuid","nullable":true},"deletedByIdentityId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","position","projectId","createdAt","updatedAt"],"additionalProperties":false}},"required":["message","projectId","environment"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/environments/{id}":{"patch":{"operationId":"updateEnvironment","tags":["Environments"],"description":"Update environment","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":64,"description":"The new slug of the environment."},"name":{"type":"string","minLength":1,"maxLength":255,"description":"The new name of the environment."},"position":{"type":"number","description":"The new position of the environment. The lowest number will be displayed as the first environment."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to update the environment in."},{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the environment to update."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"projectId":{"type":"string"},"environment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"position":{"type":"number"},"projectId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deleteAfter":{"type":"string","format":"date-time","nullable":true},"softDeletedAt":{"type":"string","format":"date-time","nullable":true},"deletedByUserId":{"type":"string","format":"uuid","nullable":true},"deletedByIdentityId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","position","projectId","createdAt","updatedAt"],"additionalProperties":false}},"required":["message","projectId","environment"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteEnvironment","tags":["Environments"],"description":"Delete environment","parameters":[{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"hardDelete","required":false,"description":"When true, permanently removes the environment. When false or omitted, the environment is soft-deleted (preserved and scheduled for permanent deletion after a grace period) and hidden from subsequent reads."},{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to delete the environment from."},{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the environment to delete."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"projectId":{"type":"string"},"environment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"position":{"type":"number"},"projectId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deleteAfter":{"type":"string","format":"date-time","nullable":true},"softDeletedAt":{"type":"string","format":"date-time","nullable":true},"deletedByUserId":{"type":"string","format":"uuid","nullable":true},"deletedByIdentityId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","position","projectId","createdAt","updatedAt"],"additionalProperties":false}},"required":["message","projectId","environment"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/environments/{id}/restore":{"post":{"operationId":"restoreEnvironment","tags":["Environments"],"description":"Restore a soft-deleted environment","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project the environment belongs to."},{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the soft-deleted environment to restore."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"projectId":{"type":"string"},"environment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"position":{"type":"number"},"projectId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deleteAfter":{"type":"string","format":"date-time","nullable":true},"softDeletedAt":{"type":"string","format":"date-time","nullable":true},"deletedByUserId":{"type":"string","format":"uuid","nullable":true},"deletedByIdentityId":{"type":"string","format":"uuid","nullable":true}},"required":["id","name","slug","position","projectId","createdAt","updatedAt"],"additionalProperties":false}},"required":["message","projectId","environment"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/tags":{"get":{"operationId":"listSecretTags","tags":["Folders"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to list tags from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"color":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string"},"createdByActorType":{"type":"string","default":"user"}},"required":["id","slug","createdAt","updatedAt","projectId"],"additionalProperties":false}}},"required":["tags"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createSecretTag","tags":["Folders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":64,"description":"The slug of the tag to create."},"color":{"type":"string","description":"The color of the tag to create."}},"required":["slug","color"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to create the tag in."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"color":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string"},"createdByActorType":{"type":"string","default":"user"}},"required":["id","slug","createdAt","updatedAt","projectId"],"additionalProperties":false}},"required":["tag"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/tags/{tagId}":{"get":{"operationId":"getSecretTagById","tags":["Folders"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to get tags from."},{"schema":{"type":"string"},"in":"path","name":"tagId","required":true,"description":"The ID of the tag to get details."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"color":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string"},"createdByActorType":{"type":"string","default":"user"},"name":{"type":"string"}},"required":["id","slug","createdAt","updatedAt","projectId","name"],"additionalProperties":false}},"required":["tag"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateSecretTag","tags":["Folders"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":64,"description":"The slug of the tag to update."},"color":{"type":"string","description":"The color of the tag to update."}},"required":["slug","color"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to update the tag in."},{"schema":{"type":"string"},"in":"path","name":"tagId","required":true,"description":"The ID of the tag to get details."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"color":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string"},"createdByActorType":{"type":"string","default":"user"}},"required":["id","slug","createdAt","updatedAt","projectId"],"additionalProperties":false}},"required":["tag"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteSecretTag","tags":["Folders"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to delete the tag from."},{"schema":{"type":"string"},"in":"path","name":"tagId","required":true,"description":"The ID of the tag to delete."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"color":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string"},"createdByActorType":{"type":"string","default":"user"}},"required":["id","slug","createdAt","updatedAt","projectId"],"additionalProperties":false}},"required":["tag"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/tags/slug/{tagSlug}":{"get":{"operationId":"getSecretTagBySlug","tags":["Folders"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to get tags from."},{"schema":{"type":"string"},"in":"path","name":"tagSlug","required":true,"description":"The slug of the tag to get details."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"tag":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string"},"color":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string"},"createdByActorType":{"type":"string","default":"user"},"name":{"type":"string"}},"required":["id","slug","createdAt","updatedAt","projectId","name"],"additionalProperties":false}},"required":["tag"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/groups/{groupIdOrName}":{"post":{"operationId":"addGroupToProject","tags":["Project Groups"],"description":"Deprecated: Use POST /api/v1/projects/:projectId/memberships/groups/:groupId instead. Add group to project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","minLength":1,"default":"no-access","description":"The role for the group to assume in the project."},"roles":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[false],"default":false}},"required":["role"],"additionalProperties":false},{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[true]},"temporaryMode":{"type":"string","enum":["relative"]},"temporaryRange":{"type":"string"},"temporaryAccessStartTime":{"type":"string","format":"date-time"}},"required":["role","isTemporary","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}]}}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to add the group to."},{"schema":{"type":"string"},"in":"path","name":"groupIdOrName","required":true,"description":"The ID or name of the group to add to the project."}],"deprecated":true,"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groupMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"groupId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","groupId","createdAt","updatedAt"],"additionalProperties":false}},"required":["groupMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/groups/{groupId}":{"patch":{"operationId":"updateProjectGroup","tags":["Project Groups"],"description":"Deprecated: Use PATCH /api/v1/projects/:projectId/memberships/groups/:groupId instead. Update group in project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[false],"default":false}},"required":["role"],"additionalProperties":false},{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[true]},"temporaryMode":{"type":"string","enum":["relative"]},"temporaryRange":{"type":"string"},"temporaryAccessStartTime":{"type":"string","format":"date-time"}},"required":["role","isTemporary","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}]},"minItems":1,"description":"A list of roles to update the group to."}},"required":["roles"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to update the group in."},{"schema":{"type":"string"},"in":"path","name":"groupId","required":true,"description":"The ID of the group to update in the project."}],"deprecated":true,"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string"},"projectMembershipId":{"type":"string","format":"uuid"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"isTemporary":{"type":"boolean","default":false},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","role","projectMembershipId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["roles"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removeGroupFromProject","tags":["Project Groups"],"description":"Deprecated: Use DELETE /api/v1/projects/:projectId/memberships/groups/:groupId instead. Remove group from project.","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to delete the group from."},{"schema":{"type":"string"},"in":"path","name":"groupId","required":true,"description":"The ID of the group to delete from the project."}],"deprecated":true,"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groupMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"groupId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","groupId","createdAt","updatedAt"],"additionalProperties":false}},"required":["groupMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getProjectGroup","tags":["Project Groups"],"description":"Deprecated: Use GET /api/v1/projects/:projectId/memberships/groups/:groupId instead. Return project group.","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true},{"schema":{"type":"string"},"in":"path","name":"groupId","required":true}],"deprecated":true,"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groupMembership":{"type":"object","properties":{"id":{"type":"string"},"groupId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true}},"required":["id","role","isTemporary"],"additionalProperties":false}},"group":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"slug":{"type":"string"}},"required":["name","id","slug"],"additionalProperties":false}},"required":["id","groupId","createdAt","updatedAt","roles","group"],"additionalProperties":false}},"required":["groupMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/groups":{"get":{"operationId":"listProjectGroups","tags":["Project Groups"],"description":"Deprecated: Use GET /api/v1/projects/:projectId/memberships/groups instead. Return list of groups in project.","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to list groups for."}],"deprecated":true,"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groupMemberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"groupId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true}},"required":["id","role","isTemporary"],"additionalProperties":false}},"group":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug"],"additionalProperties":false}},"required":["id","groupId","createdAt","updatedAt","roles","group"],"additionalProperties":false}}},"required":["groupMemberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/identity-memberships/{identityId}":{"post":{"tags":["Project Identities"],"description":"Create project identity membership","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","default":"no-access"},"roles":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"role":{"type":"string","description":"The role slug to assign to the newly created identity project membership."},"isTemporary":{"type":"boolean","enum":[false],"default":false,"description":"The role slug to assign to the newly created identity project membership."}},"required":["role"],"additionalProperties":false},{"type":"object","properties":{"role":{"type":"string","description":"The role slug to assign to the newly created identity project membership."},"isTemporary":{"type":"boolean","enum":[true],"description":"The role slug to assign to the newly created identity project membership."},"temporaryMode":{"type":"string","enum":["relative"],"description":"The role slug to assign to the newly created identity project membership."},"temporaryRange":{"type":"string","description":"The role slug to assign to the newly created identity project membership."},"temporaryAccessStartTime":{"type":"string","format":"date-time","description":"The role slug to assign to the newly created identity project membership."}},"required":["role","isTemporary","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}]},"description":"A list of role slugs to assign to the newly created identity project membership."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true},{"schema":{"type":"string"},"in":"path","name":"identityId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"identityId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","identityId","createdAt","updatedAt"],"additionalProperties":false}},"required":["identityMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["Project Identities"],"description":"Update project identity memberships","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"role":{"type":"string","description":"The role slug to assign to the newly created identity project membership."},"isTemporary":{"type":"boolean","enum":[false],"default":false,"description":"Whether the assigned role is temporary. If isTemporary is set true, must provide temporaryMode, temporaryRange and temporaryAccessStartTime."}},"required":["role"],"additionalProperties":false},{"type":"object","properties":{"role":{"type":"string","description":"The role slug to assign to the newly created identity project membership."},"isTemporary":{"type":"boolean","enum":[true],"description":"Whether the assigned role is temporary. If isTemporary is set true, must provide temporaryMode, temporaryRange and temporaryAccessStartTime."},"temporaryMode":{"type":"string","enum":["relative"],"description":"Type of temporary expiry."},"temporaryRange":{"type":"string","description":"Expiry time for temporary access. In relative mode it could be 1s, 2m ,3h, etc."},"temporaryAccessStartTime":{"type":"string","format":"date-time","description":"Time to which the temporary access starts."}},"required":["role","isTemporary","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}]},"minItems":1,"description":"A list of role slugs to assign to the identity project membership."}},"required":["roles"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to update the identity membership for."},{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the membership for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string"},"projectMembershipId":{"type":"string","format":"uuid"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"isTemporary":{"type":"boolean","default":false},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","role","projectMembershipId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["roles"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["Project Identities"],"description":"Delete project identity memberships","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to delete the identity membership from."},{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to delete the membership from."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"identityId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","identityId","createdAt","updatedAt"],"additionalProperties":false}},"required":["identityMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"tags":["Project Identities"],"description":"Return project identity membership","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to get the identity membership for."},{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to get the membership for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityMembership":{"type":"object","properties":{"id":{"type":"string"},"identityId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true}},"required":["id","role","isTemporary"],"additionalProperties":false}},"lastLoginAuthMethod":{"type":"string","nullable":true},"lastLoginTime":{"type":"string","format":"date-time","nullable":true},"identity":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string","format":"uuid"},"authMethods":{"type":"array","items":{"type":"string"}}},"required":["name","id","orgId","authMethods"],"additionalProperties":false},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}},"required":["name","id"],"additionalProperties":false}},"required":["id","identityId","createdAt","updatedAt","roles","identity","project"],"additionalProperties":false}},"required":["identityMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/identity-memberships":{"get":{"tags":["Project Identities"],"description":"Return project identity memberships","parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th identity membership."},{"schema":{"type":"number","minimum":1,"maximum":20000,"default":100},"in":"query","name":"limit","required":false,"description":"The number of identity memberships to return."},{"schema":{"type":"string","enum":["name"],"default":"name"},"in":"query","name":"orderBy","required":false,"description":"The column to order identity memberships by."},{"schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"in":"query","name":"orderDirection","required":false,"description":"The direction identity memberships will be sorted in."},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"The text string that identity membership names will be filtered by."},{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to get identity memberships from."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityMemberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"identityId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true}},"required":["id","role","isTemporary"],"additionalProperties":false}},"identity":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string","format":"uuid"},"authMethods":{"type":"array","items":{"type":"string"}}},"required":["name","id","orgId","authMethods"],"additionalProperties":false},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}},"required":["name","id"],"additionalProperties":false}},"required":["id","identityId","createdAt","updatedAt","roles","identity","project"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["identityMemberships","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/identity-memberships/{identityMembershipId}":{"get":{"tags":["Project Identities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityMembershipId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityMembership":{"type":"object","properties":{"id":{"type":"string"},"identityId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true}},"required":["id","role","isTemporary"],"additionalProperties":false}},"identity":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"authMethods":{"type":"array","items":{"type":"string"}}},"required":["name","id","authMethods"],"additionalProperties":false},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}},"required":["name","id"],"additionalProperties":false}},"required":["id","identityId","createdAt","updatedAt","roles","identity","project"],"additionalProperties":false}},"required":["identityMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/memberships/identities/{identityId}":{"post":{"operationId":"createProjectIdentityMembership","tags":["Project Identities"],"description":"Create project identity membership","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","default":"no-access"},"roles":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"role":{"type":"string","description":"The role slug to assign to the newly created identity project membership."},"isTemporary":{"type":"boolean","enum":[false],"default":false,"description":"The role slug to assign to the newly created identity project membership."}},"required":["role"],"additionalProperties":false},{"type":"object","properties":{"role":{"type":"string","description":"The role slug to assign to the newly created identity project membership."},"isTemporary":{"type":"boolean","enum":[true],"description":"The role slug to assign to the newly created identity project membership."},"temporaryMode":{"type":"string","enum":["relative"],"description":"The role slug to assign to the newly created identity project membership."},"temporaryRange":{"type":"string","description":"The role slug to assign to the newly created identity project membership."},"temporaryAccessStartTime":{"type":"string","format":"date-time","description":"The role slug to assign to the newly created identity project membership."}},"required":["role","isTemporary","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}]},"description":"A list of role slugs to assign to the newly created identity project membership."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true},{"schema":{"type":"string"},"in":"path","name":"identityId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"identityId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","identityId","createdAt","updatedAt"],"additionalProperties":false}},"required":["identityMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateProjectIdentityMembership","tags":["Project Identities"],"description":"Update project identity memberships","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"role":{"type":"string","description":"The role slug to assign to the newly created identity project membership."},"isTemporary":{"type":"boolean","enum":[false],"default":false,"description":"Whether the assigned role is temporary. If isTemporary is set true, must provide temporaryMode, temporaryRange and temporaryAccessStartTime."}},"required":["role"],"additionalProperties":false},{"type":"object","properties":{"role":{"type":"string","description":"The role slug to assign to the newly created identity project membership."},"isTemporary":{"type":"boolean","enum":[true],"description":"Whether the assigned role is temporary. If isTemporary is set true, must provide temporaryMode, temporaryRange and temporaryAccessStartTime."},"temporaryMode":{"type":"string","enum":["relative"],"description":"Type of temporary expiry."},"temporaryRange":{"type":"string","description":"Expiry time for temporary access. In relative mode it could be 1s, 2m ,3h, etc."},"temporaryAccessStartTime":{"type":"string","format":"date-time","description":"Time to which the temporary access starts."}},"required":["role","isTemporary","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}]},"minItems":1,"description":"A list of role slugs to assign to the identity project membership."}},"required":["roles"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to update the identity membership for."},{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update the membership for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"identityId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","identityId","createdAt","updatedAt"],"additionalProperties":false}},"required":["identityMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteProjectIdentityMembership","tags":["Project Identities"],"description":"Delete project identity memberships","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to delete the identity membership from."},{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to delete the membership from."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"identityId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","identityId","createdAt","updatedAt"],"additionalProperties":false}},"required":["identityMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getProjectIdentityMembershipById","tags":["Project Identity Membership"],"description":"Get project identity membership by identity ID","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to get the identity membership for."},{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to get the membership for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityMembership":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true}},"required":["id","role","isTemporary"],"additionalProperties":false}},"lastLoginAuthMethod":{"type":"string","nullable":true},"lastLoginTime":{"type":"string","format":"date-time","nullable":true},"identity":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"orgId":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"authMethods":{"type":"array","items":{"type":"string"}},"metadata":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"key":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["id","key","value"],"additionalProperties":false}}},"required":["name","id","orgId","authMethods"],"additionalProperties":false}},"required":["id","createdAt","updatedAt","roles","identity"],"additionalProperties":false}},"required":["identityMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/memberships/identities":{"get":{"operationId":"listProjectIdentityMemberships","tags":["Project Identity Membership"],"description":"List project identity memberships","parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th identity membership."},{"schema":{"type":"number","minimum":1,"maximum":1000,"default":20},"in":"query","name":"limit","required":false,"description":"The number of identity memberships to return."},{"schema":{"type":"string"},"in":"query","name":"identityName","required":false,"description":"The text string that identity membership names will be filtered by."},{"schema":{"type":"string"},"in":"query","name":"roles","required":false,"description":"The role slugs to filter identity memberships by."},{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to list identity memberships from."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityMemberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"identityId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true}},"required":["id","role","isTemporary"],"additionalProperties":false}},"identity":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"orgId":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"authMethods":{"type":"array","items":{"type":"string"}},"activeLockoutAuthMethods":{"type":"array","items":{"type":"string"}}},"required":["name","id","orgId","authMethods","activeLockoutAuthMethods"],"additionalProperties":false}},"required":["id","identityId","createdAt","updatedAt","roles","identity"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["identityMemberships","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/memberships/available-identities":{"get":{"operationId":"listAvailableProjectIdentities","tags":["Project Identity Membership"],"description":"List available identities for project membership","parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th identity."},{"schema":{"type":"number","minimum":1,"maximum":1000,"default":20},"in":"query","name":"limit","required":false,"description":"The number of identities to return."},{"schema":{"type":"string"},"in":"query","name":"identityName","required":false,"description":"The text string that identity membership names will be filtered by."},{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to list available identities for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}}},"required":["identities"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/memberships/groups":{"get":{"operationId":"listProjectGroupMemberships","tags":["Project Groups"],"description":"List project group memberships.","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true,"description":"The ID of the project to list groups for."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groupMemberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"groupId":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"group":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug"],"additionalProperties":false},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","role","isTemporary"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","groupId","projectId","group","roles","createdAt","updatedAt"],"additionalProperties":false}}},"required":["groupMemberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/projects/{projectId}/memberships/groups/{groupId}":{"post":{"operationId":"createProjectGroupMembership","tags":["Project Groups"],"description":"Add a group from the organization to the project by creating a project group membership.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","minLength":1,"default":"no-access"},"roles":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[false],"default":false}},"required":["role"],"additionalProperties":false},{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[true]},"temporaryMode":{"type":"string","enum":["relative"]},"temporaryRange":{"type":"string"},"temporaryAccessStartTime":{"type":"string","format":"date-time"}},"required":["role","isTemporary","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}]}}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"groupId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groupMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"groupId":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"group":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug"],"additionalProperties":false},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","role","isTemporary"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","groupId","projectId","group","roles","createdAt","updatedAt"],"additionalProperties":false}},"required":["groupMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getProjectGroupMembership","tags":["Project Groups"],"description":"Get project group membership by group ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"groupId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groupMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"groupId":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"group":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"orgId":{"type":"string","format":"uuid"}},"required":["id","name","slug"],"additionalProperties":false},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","role","isTemporary"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","groupId","projectId","group","roles","createdAt","updatedAt"],"additionalProperties":false}},"required":["groupMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateProjectGroupMembership","tags":["Project Groups"],"description":"Update project group membership roles.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[false],"default":false}},"required":["role"],"additionalProperties":false},{"type":"object","properties":{"role":{"type":"string"},"isTemporary":{"type":"boolean","enum":[true]},"temporaryMode":{"type":"string","enum":["relative"]},"temporaryRange":{"type":"string"},"temporaryAccessStartTime":{"type":"string","format":"date-time"}},"required":["role","isTemporary","temporaryMode","temporaryRange","temporaryAccessStartTime"],"additionalProperties":false}]},"minItems":1,"description":"A list of roles to update the group to."}},"required":["roles"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"groupId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string"},"projectMembershipId":{"type":"string","format":"uuid"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"isTemporary":{"type":"boolean","default":false},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","role","projectMembershipId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["roles"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removeProjectGroupMembership","tags":["Project Groups"],"description":"Remove group from project.","parameters":[{"schema":{"type":"string"},"in":"path","name":"projectId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"groupId","required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"groupMembership":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"groupId":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","groupId","projectId","createdAt","updatedAt"],"additionalProperties":false}},"required":["groupMembership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/hsm-connectors":{"post":{"operationId":"createHsmConnector","tags":["HSM Connectors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32},"description":{"type":"string","maxLength":256},"gatewayId":{"type":"string","format":"uuid"},"gatewayPoolId":{"type":"string","format":"uuid"},"credentials":{"type":"object","properties":{"slotLabel":{"type":"string","minLength":1,"maxLength":128},"pin":{"type":"string","minLength":1,"maxLength":512},"keyNamePrefix":{"type":"string","minLength":1,"maxLength":64}},"required":["slotLabel","pin"],"additionalProperties":false}},"required":["name","credentials"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"hsmConnector":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"slotLabel":{"type":"string"},"keyNamePrefix":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","description","gatewayId","gatewayPoolId","slotLabel","keyNamePrefix","createdAt","updatedAt"],"additionalProperties":false}},"required":["hsmConnector"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listHsmConnectors","tags":["HSM Connectors"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"hsmConnectors":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"slotLabel":{"type":"string"},"keyNamePrefix":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","description","gatewayId","gatewayPoolId","slotLabel","keyNamePrefix","createdAt","updatedAt"],"additionalProperties":false}}},"required":["hsmConnectors"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/hsm-connectors/{connectorId}":{"get":{"operationId":"getHsmConnector","tags":["HSM Connectors"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectorId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"hsmConnector":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"slotLabel":{"type":"string"},"keyNamePrefix":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","description","gatewayId","gatewayPoolId","slotLabel","keyNamePrefix","createdAt","updatedAt"],"additionalProperties":false}},"required":["hsmConnector"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateHsmConnector","tags":["HSM Connectors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32},"description":{"type":"string","maxLength":256},"gatewayId":{"type":"string","format":"uuid","nullable":true},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"credentials":{"type":"object","properties":{"slotLabel":{"type":"string","minLength":1,"maxLength":128},"pin":{"type":"string","minLength":1,"maxLength":512},"keyNamePrefix":{"type":"string","minLength":1,"maxLength":64}},"additionalProperties":false}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectorId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"hsmConnector":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"slotLabel":{"type":"string"},"keyNamePrefix":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","description","gatewayId","gatewayPoolId","slotLabel","keyNamePrefix","createdAt","updatedAt"],"additionalProperties":false}},"required":["hsmConnector"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteHsmConnector","tags":["HSM Connectors"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectorId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/hsm-connectors/{connectorId}/test":{"post":{"operationId":"testHsmConnector","tags":["HSM Connectors"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectorId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"members":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"gatewayId":{"type":"string","format":"uuid"},"ok":{"type":"boolean","enum":[true]},"slotInfo":{"type":"object","properties":{"manufacturer":{"type":"string"},"model":{"type":"string"},"firmware":{"type":"string"}},"required":["manufacturer","model","firmware"],"additionalProperties":false}},"required":["gatewayId","ok","slotInfo"],"additionalProperties":false},{"type":"object","properties":{"gatewayId":{"type":"string","format":"uuid"},"ok":{"type":"boolean","enum":[false]},"errorCode":{"type":"string"},"errorMessage":{"type":"string"}},"required":["gatewayId","ok","errorCode","errorMessage"],"additionalProperties":false}]},"minItems":1}},"required":["ok","members"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/hsm-connectors/{connectorId}/linked-resources":{"get":{"operationId":"listHsmConnectorLinkedResources","tags":["HSM Connectors"],"parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectorId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"commonName":{"type":"string"},"status":{"type":"string"},"notAfter":{"type":"string","format":"date-time"},"hsmKeyLabel":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"}},"required":["id","commonName","status","notAfter","hsmKeyLabel","createdAt"],"additionalProperties":false}},"certificateAuthorities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"commonName":{"type":"string","nullable":true},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["root","intermediate"]},"hsmKeyLabel":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"}},"required":["id","name","commonName","status","type","hsmKeyLabel","createdAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["certificates","certificateAuthorities","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal":{"get":{"operationId":"listInternalCertificateAuthoritiesV1","tags":["PKI Certificate Authorities"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["internal"]},"configuration":{"type":"object","properties":{"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"default":"","description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"default":"","description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"default":"","description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"default":"","description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"default":"","description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"default":"","description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"nullable":true,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"keySource":{"type":"string","enum":["infisical","hsm"],"description":"Where the CA's signing key is generated and stored. 'infisical' keeps the key in Infisical's KMS; 'hsm' generates and stores the key in the HSM reached through the specified HSM Connector."},"hsmConnectorId":{"type":"string","format":"uuid","description":"The ID of the HSM Connector to generate and store the CA's signing key in. Required when keySource is 'hsm'."},"hsmKeyLabel":{"type":"string","description":"The label of the CA's signing key on the HSM. Not user-supplied: it is the HSM Connector's configured key name prefix followed by a per-CA label built from the CA name and a random 5-character suffix (ca-<name>-<slug>)."},"dn":{"type":"string","maxLength":255,"nullable":true},"parentCaId":{"type":"string","format":"uuid","nullable":true},"serialNumber":{"type":"string","nullable":true},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false,"description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"required":["type","keyAlgorithm"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createInternalCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Internal Certificate Authority to create. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The status of the Internal Certificate Authority."},"configuration":{"type":"object","properties":{"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"default":"","description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"default":"","description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"default":"","description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"default":"","description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"default":"","description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"default":"","description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"nullable":true,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"keySource":{"type":"string","enum":["infisical","hsm"],"description":"Where the CA's signing key is generated and stored. 'infisical' keeps the key in Infisical's KMS; 'hsm' generates and stores the key in the HSM reached through the specified HSM Connector."},"hsmConnectorId":{"type":"string","format":"uuid","description":"The ID of the HSM Connector to generate and store the CA's signing key in. Required when keySource is 'hsm'."},"hsmKeyLabel":{"type":"string","description":"The label of the CA's signing key on the HSM. Not user-supplied: it is the HSM Connector's configured key name prefix followed by a per-CA label built from the CA name and a random 5-character suffix (ca-<name>-<slug>)."},"dn":{"type":"string","maxLength":255,"nullable":true},"parentCaId":{"type":"string","format":"uuid","nullable":true},"serialNumber":{"type":"string","nullable":true},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false,"description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"required":["type","keyAlgorithm"],"additionalProperties":false}},"required":["name","status","configuration"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["internal"]},"configuration":{"type":"object","properties":{"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"default":"","description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"default":"","description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"default":"","description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"default":"","description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"default":"","description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"default":"","description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"nullable":true,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"keySource":{"type":"string","enum":["infisical","hsm"],"description":"Where the CA's signing key is generated and stored. 'infisical' keeps the key in Infisical's KMS; 'hsm' generates and stores the key in the HSM reached through the specified HSM Connector."},"hsmConnectorId":{"type":"string","format":"uuid","description":"The ID of the HSM Connector to generate and store the CA's signing key in. Required when keySource is 'hsm'."},"hsmKeyLabel":{"type":"string","description":"The label of the CA's signing key on the HSM. Not user-supplied: it is the HSM Connector's configured key name prefix followed by a per-CA label built from the CA name and a random 5-character suffix (ca-<name>-<slug>)."},"dn":{"type":"string","maxLength":255,"nullable":true},"parentCaId":{"type":"string","format":"uuid","nullable":true},"serialNumber":{"type":"string","nullable":true},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false,"description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"required":["type","keyAlgorithm"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{id}":{"get":{"operationId":"getInternalCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["internal"]},"configuration":{"type":"object","properties":{"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"default":"","description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"default":"","description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"default":"","description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"default":"","description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"default":"","description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"default":"","description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"nullable":true,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"keySource":{"type":"string","enum":["infisical","hsm"],"description":"Where the CA's signing key is generated and stored. 'infisical' keeps the key in Infisical's KMS; 'hsm' generates and stores the key in the HSM reached through the specified HSM Connector."},"hsmConnectorId":{"type":"string","format":"uuid","description":"The ID of the HSM Connector to generate and store the CA's signing key in. Required when keySource is 'hsm'."},"hsmKeyLabel":{"type":"string","description":"The label of the CA's signing key on the HSM. Not user-supplied: it is the HSM Connector's configured key name prefix followed by a per-CA label built from the CA name and a random 5-character suffix (ca-<name>-<slug>)."},"dn":{"type":"string","maxLength":255,"nullable":true},"parentCaId":{"type":"string","format":"uuid","nullable":true},"serialNumber":{"type":"string","nullable":true},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false,"description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"required":["type","keyAlgorithm"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateInternalCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Internal Certificate Authority. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The updated status of the Internal Certificate Authority."},"configuration":{"type":"object","properties":{"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"additionalProperties":false}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["internal"]},"configuration":{"type":"object","properties":{"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"default":"","description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"default":"","description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"default":"","description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"default":"","description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"default":"","description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"default":"","description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"nullable":true,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"keySource":{"type":"string","enum":["infisical","hsm"],"description":"Where the CA's signing key is generated and stored. 'infisical' keeps the key in Infisical's KMS; 'hsm' generates and stores the key in the HSM reached through the specified HSM Connector."},"hsmConnectorId":{"type":"string","format":"uuid","description":"The ID of the HSM Connector to generate and store the CA's signing key in. Required when keySource is 'hsm'."},"hsmKeyLabel":{"type":"string","description":"The label of the CA's signing key on the HSM. Not user-supplied: it is the HSM Connector's configured key name prefix followed by a per-CA label built from the CA name and a random 5-character suffix (ca-<name>-<slug>)."},"dn":{"type":"string","maxLength":255,"nullable":true},"parentCaId":{"type":"string","format":"uuid","nullable":true},"serialNumber":{"type":"string","nullable":true},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false,"description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"required":["type","keyAlgorithm"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteInternalCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["internal"]},"configuration":{"type":"object","properties":{"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"default":"","description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"default":"","description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"default":"","description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"default":"","description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"default":"","description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"default":"","description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"nullable":true,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"keySource":{"type":"string","enum":["infisical","hsm"],"description":"Where the CA's signing key is generated and stored. 'infisical' keeps the key in Infisical's KMS; 'hsm' generates and stores the key in the HSM reached through the specified HSM Connector."},"hsmConnectorId":{"type":"string","format":"uuid","description":"The ID of the HSM Connector to generate and store the CA's signing key in. Required when keySource is 'hsm'."},"hsmKeyLabel":{"type":"string","description":"The label of the CA's signing key on the HSM. Not user-supplied: it is the HSM Connector's configured key name prefix followed by a per-CA label built from the CA name and a random 5-character suffix (ca-<name>-<slug>)."},"dn":{"type":"string","maxLength":255,"nullable":true},"parentCaId":{"type":"string","format":"uuid","nullable":true},"serialNumber":{"type":"string","nullable":true},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false,"description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"required":["type","keyAlgorithm"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/csr":{"get":{"operationId":"getCaCsr","tags":["PKI Certificate Authorities"],"description":"Get CA CSR","parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to generate CSR from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"csr":{"type":"string","description":"The generated CSR from the CA."}},"required":["csr"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/renew":{"post":{"operationId":"renewCaCertificate","tags":["PKI Certificate Authorities"],"description":"Perform CA certificate renewal","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["existing"],"description":"The type of behavior to use for the renewal operation. Currently Infisical is only able to renew a CA certificate with the same key pair."},"notAfter":{"type":"string","description":"The expiry date and time for the renewed CA certificate in YYYY-MM-DDTHH:mm:ss.sssZ format."}},"required":["type","notAfter"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to renew the CA certificate for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The renewed CA certificate body."},"certificateChain":{"type":"string","description":"The certificate chain of the CA."},"serialNumber":{"type":"string","description":"The serial number of the renewed CA certificate."},"certId":{"type":"string","description":"Certificate ID"}},"required":["certificate","certificateChain","serialNumber","certId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/certificate":{"post":{"tags":["PKI Certificate Authorities"],"description":"Generate certificate for a Certificate Authority","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"default":-1,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"parentCaId":{"type":"string","description":"Parent CA ID for intermediate certificate generation"}},"required":["notBefore","notAfter"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to generate a certificate for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The generated CA certificate."},"certificateChain":{"type":"string","description":"The certificate chain of the CA."},"serialNumber":{"type":"string","description":"The serial number of the CA certificate."},"certId":{"type":"string","description":"Certificate ID"}},"required":["certificate","certificateChain","serialNumber","certId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getCaCertificate","tags":["PKI Certificate Authorities"],"description":"Get current CA cert and cert chain of a CA","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to get the certificate body and certificate chain from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The certificate body of the CA."},"certificateChain":{"type":"string","description":"The certificate chain of the CA."},"serialNumber":{"type":"string","description":"The serial number of the CA certificate."},"certId":{"type":"string","description":"Certificate ID"}},"required":["certificate","certificateChain","serialNumber","certId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/ca-certificates":{"get":{"operationId":"getCaCertificates","tags":["PKI Certificate Authorities"],"description":"Get list of past and current CA certificates for a CA","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to get the CA certificates for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"certificate":{"type":"string","description":"The certificate body of the CA certificate."},"certificateChain":{"type":"string","description":"The certificate chain of the CA certificate."},"serialNumber":{"type":"string","description":"The serial number of the CA certificate."},"certId":{"type":"string","description":"Certificate ID"},"version":{"type":"number","description":"The version of the CA certificate. The version is incremented for each CA renewal operation."}},"required":["certificate","certificateChain","serialNumber","certId","version"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/certificate/{certId}":{"get":{"tags":["PKI Certificate Authorities"],"description":"Get a specific CA certificate by ID","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to get the certificate body and certificate chain from."},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"certId","required":true,"description":"Certificate ID to retrieve"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The certificate body of the CA."},"certificateChain":{"type":"string","description":"The certificate chain of the CA."},"serialNumber":{"type":"string","description":"The serial number of the CA certificate."},"certId":{"type":"string","description":"Certificate ID"},"notBefore":{"type":"string"},"notAfter":{"type":"string"},"maxPathLength":{"type":"number"},"parentCaId":{"type":"string","format":"uuid"}},"required":["certificate","certificateChain","serialNumber","certId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/sign-intermediate":{"post":{"operationId":"signIntermediateCa","tags":["PKI Certificate Authorities"],"description":"Create intermediate CA certificate from parent CA","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"csr":{"type":"string","minLength":1,"description":"The pem-encoded CSR to sign with the CA."},"notBefore":{"type":"string","description":"The date and time when the intermediate CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the intermediate CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"default":-1,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."}},"required":["csr","notAfter"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to sign the intermediate certificate with."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The signed intermediate certificate."},"certificateChain":{"type":"string","description":"The certificate chain of the intermediate certificate."},"issuingCaCertificate":{"type":"string","description":"The certificate of the issuing CA."},"serialNumber":{"type":"string","description":"The serial number of the intermediate certificate."}},"required":["certificate","certificateChain","issuingCaCertificate","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/import-certificate":{"post":{"operationId":"importCaCertificate","tags":["PKI Certificate Authorities"],"description":"Import certificate and chain to CA","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The certificate body to import."},"certificateChain":{"type":"string","description":"The certificate chain to import."}},"required":["certificate","certificateChain"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to import the certificate for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"caId":{"type":"string"}},"required":["message","caId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/crls":{"get":{"operationId":"getCaCrls","tags":["PKI Certificate Authorities"],"description":"Get list of CRLs of the CA","parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to get the certificate revocation lists (CRLs) for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of certificate revocation list (CRL)."},"crl":{"type":"string","description":"The certificate revocation list (CRL)."}},"required":["id","crl"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/certificates/{caCertId}/der":{"get":{"operationId":"getCaCertificateDer","tags":["PKI Certificate Authorities"],"description":"Get DER-encoded certificate of CA","parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to get the CA certificate from."},{"schema":{"type":"string"},"in":"path","name":"caCertId","required":true,"description":"The ID of the CA certificate to get."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/install-certificate-venafi":{"post":{"operationId":"installCaCertificateVenafi","tags":["PKI Certificate Authorities"],"description":"Install a CA certificate via Venafi TLS Protect Cloud","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"maxPathLength":{"type":"number","minimum":-1,"default":-1}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to install the certificate for via Venafi."}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"caId":{"type":"string"}},"required":["message","caId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/install-certificate-adcs":{"post":{"operationId":"installCaCertificateAdcs","tags":["PKI Certificate Authorities"],"description":"Install a CA certificate via Azure AD CS (Web Enrollment)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"maxPathLength":{"type":"number","minimum":-1,"default":-1}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to install the certificate for via Azure AD CS."}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"caId":{"type":"string"}},"required":["message","caId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/install-certificate-microsoft-adcs":{"post":{"operationId":"installCaCertificateAdcsNative","tags":["PKI Certificate Authorities"],"description":"Install a CA certificate via ADCS","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"maxPathLength":{"type":"number","minimum":-1,"default":-1}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to install the certificate for via ADCS."}],"responses":{"202":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"caId":{"type":"string"}},"required":["message","caId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/signing-config":{"post":{"operationId":"createCaSigningConfig","tags":["PKI Certificate Authorities"],"description":"Create a signing configuration for a CA","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["internal"]},"parentCaId":{"type":"string","format":"uuid"}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["manual"]}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["venafi"]},"appConnectionId":{"type":"string","format":"uuid"},"destinationConfig":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"issuingTemplateId":{"type":"string","format":"uuid"},"validityPeriod":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["applicationId","issuingTemplateId"],"additionalProperties":false}},"required":["type","appConnectionId","destinationConfig"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["azure-ad-cs"]},"appConnectionId":{"type":"string","format":"uuid"},"destinationConfig":{"type":"object","properties":{"template":{"type":"string","minLength":1},"validityPeriod":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["template"],"additionalProperties":false}},"required":["type","appConnectionId","destinationConfig"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["adcs"]},"appConnectionId":{"type":"string","format":"uuid"},"destinationConfig":{"type":"object","properties":{"template":{"type":"string","minLength":1},"caName":{"type":"string","minLength":1}},"required":["template"],"additionalProperties":false}},"required":["type","appConnectionId","destinationConfig"],"additionalProperties":false}]}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to create a signing configuration for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid"},"type":{"type":"string"},"parentCaId":{"type":"string","format":"uuid","nullable":true},"appConnectionId":{"type":"string","format":"uuid","nullable":true},"destinationConfig":{"nullable":true},"lastExternalCertificateId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","caId","type","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getCaSigningConfig","tags":["PKI Certificate Authorities"],"description":"Get the signing configuration for a CA","parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to get the signing configuration for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid"},"type":{"type":"string"},"parentCaId":{"type":"string","format":"uuid","nullable":true},"appConnectionId":{"type":"string","format":"uuid","nullable":true},"destinationConfig":{"nullable":true},"lastExternalCertificateId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","caId","type","createdAt","updatedAt"],"additionalProperties":false,"nullable":true}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateCaSigningConfig","tags":["PKI Certificate Authorities"],"description":"Update the signing configuration for a CA","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"parentCaId":{"type":"string","format":"uuid"},"appConnectionId":{"type":"string","format":"uuid"},"destinationConfig":{"anyOf":[{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"issuingTemplateId":{"type":"string","format":"uuid"},"validityPeriod":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["applicationId","issuingTemplateId"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1},"validityPeriod":{"type":"integer","exclusiveMinimum":true,"minimum":0}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1},"caName":{"type":"string","minLength":1}},"required":["template"],"additionalProperties":false}]}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to update the signing configuration for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid"},"type":{"type":"string"},"parentCaId":{"type":"string","format":"uuid","nullable":true},"appConnectionId":{"type":"string","format":"uuid","nullable":true},"destinationConfig":{"nullable":true},"lastExternalCertificateId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","caId","type","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/internal/{caId}/auto-renewal":{"get":{"operationId":"getCaAutoRenewalConfig","tags":["PKI Certificate Authorities"],"description":"Get auto-renewal configuration for a CA","parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to get the auto-renewal configuration for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"autoRenewalEnabled":{"type":"boolean"},"autoRenewalDaysBeforeExpiry":{"type":"number","nullable":true},"lastRenewalStatus":{"type":"string","nullable":true},"lastRenewalMessage":{"type":"string","nullable":true},"lastRenewalAt":{"type":"string","format":"date-time","nullable":true}},"required":["autoRenewalEnabled","autoRenewalDaysBeforeExpiry","lastRenewalStatus","lastRenewalMessage","lastRenewalAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateCaAutoRenewalConfig","tags":["PKI Certificate Authorities"],"description":"Update auto-renewal configuration for a CA","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"autoRenewalEnabled":{"type":"boolean"},"autoRenewalDaysBeforeExpiry":{"type":"number","minimum":1,"maximum":365}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to update the auto-renewal configuration for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"autoRenewalEnabled":{"type":"boolean"},"autoRenewalDaysBeforeExpiry":{"type":"number","nullable":true},"lastRenewalStatus":{"type":"string","nullable":true},"lastRenewalMessage":{"type":"string","nullable":true},"lastRenewalAt":{"type":"string","format":"date-time","nullable":true}},"required":["autoRenewalEnabled","autoRenewalDaysBeforeExpiry","lastRenewalStatus","lastRenewalMessage","lastRenewalAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/acme":{"get":{"operationId":"listAcmeCertificateAuthoritiesV1","tags":["PKI Certificate Authorities"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["acme"]},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAcmeCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the ACME-compatible CA Certificate Authority to create. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The status of the ACME-compatible CA Certificate Authority."},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"eabHmacKey":{"type":"string","maxLength":512,"description":"The External Account Binding (EAB) HMAC key for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["name","status","configuration"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["acme"]},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/acme/{id}":{"get":{"operationId":"getAcmeCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["acme"]},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAcmeCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the ACME-compatible CA Certificate Authority. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The updated status of the ACME-compatible CA Certificate Authority."},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"eabHmacKey":{"type":"string","maxLength":512,"description":"The External Account Binding (EAB) HMAC key for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["acme"]},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAcmeCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["acme"]},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/azure-ad-cs":{"get":{"operationId":"listAzureAdCsCertificateAuthoritiesV1","tags":["PKI Certificate Authorities"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["azure-ad-cs"]},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAzureAdCsCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Active Directory Certificate Service Certificate Authority to create. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The status of the Active Directory Certificate Service Certificate Authority."},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["name","status","configuration"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["azure-ad-cs"]},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/azure-ad-cs/{id}":{"get":{"operationId":"getAzureAdCsCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["azure-ad-cs"]},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAzureAdCsCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Active Directory Certificate Service Certificate Authority. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The updated status of the Active Directory Certificate Service Certificate Authority."},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["azure-ad-cs"]},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAzureAdCsCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["azure-ad-cs"]},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/azure-ad-cs/{caId}/templates":{"get":{"operationId":"getAzureAdcsTemplates","description":"Get available certificate templates from Azure AD CS CA","parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"Azure AD CS CA ID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Template identifier"},"name":{"type":"string","description":"Template display name"},"description":{"type":"string","description":"Template description"}},"required":["id","name"],"additionalProperties":false}}},"required":["templates"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/adcs":{"get":{"operationId":"listAdcsCertificateAuthoritiesV1","tags":["PKI Certificate Authorities"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["adcs"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ADCS App Connection ID."},"caName":{"type":"string","minLength":1,"description":"The AD CS certification authority name. Optional: discovered automatically from the CA host when omitted."}},"required":["appConnectionId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAdcsCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Microsoft ADCS Certificate Authority to create. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The status of the Microsoft ADCS Certificate Authority."},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ADCS App Connection ID."},"caName":{"type":"string","minLength":1,"description":"The AD CS certification authority name. Optional: discovered automatically from the CA host when omitted."}},"required":["appConnectionId"],"additionalProperties":false}},"required":["name","status","configuration"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["adcs"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ADCS App Connection ID."},"caName":{"type":"string","minLength":1,"description":"The AD CS certification authority name. Optional: discovered automatically from the CA host when omitted."}},"required":["appConnectionId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/adcs/{id}":{"get":{"operationId":"getAdcsCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["adcs"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ADCS App Connection ID."},"caName":{"type":"string","minLength":1,"description":"The AD CS certification authority name. Optional: discovered automatically from the CA host when omitted."}},"required":["appConnectionId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAdcsCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Microsoft ADCS Certificate Authority. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The updated status of the Microsoft ADCS Certificate Authority."},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ADCS App Connection ID."},"caName":{"type":"string","minLength":1,"description":"The AD CS certification authority name. Optional: discovered automatically from the CA host when omitted."}},"required":["appConnectionId"],"additionalProperties":false}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["adcs"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ADCS App Connection ID."},"caName":{"type":"string","minLength":1,"description":"The AD CS certification authority name. Optional: discovered automatically from the CA host when omitted."}},"required":["appConnectionId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAdcsCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["adcs"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ADCS App Connection ID."},"caName":{"type":"string","minLength":1,"description":"The AD CS certification authority name. Optional: discovered automatically from the CA host when omitted."}},"required":["appConnectionId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/adcs/{caId}/templates":{"get":{"operationId":"getAdcsTemplates","description":"Get available certificate templates from ADCS CA","parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"ADCS CA ID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Template identifier"},"name":{"type":"string","description":"Template display name"}},"required":["id","name"],"additionalProperties":false}}},"required":["templates"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/aws-pca":{"get":{"operationId":"listAwsPcaCertificateAuthoritiesV1","tags":["PKI Certificate Authorities"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["aws-pca"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA."},"certificateAuthorityArn":{"type":"string","minLength":1,"description":"The ARN of the AWS Private Certificate Authority to use for issuing certificates."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region where the Private Certificate Authority is located."}},"required":["appConnectionId","certificateAuthorityArn","region"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAwsPcaCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the AWS Private Certificate Authority Certificate Authority to create. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The status of the AWS Private Certificate Authority Certificate Authority."},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA."},"certificateAuthorityArn":{"type":"string","minLength":1,"description":"The ARN of the AWS Private Certificate Authority to use for issuing certificates."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region where the Private Certificate Authority is located."}},"required":["appConnectionId","certificateAuthorityArn","region"],"additionalProperties":false}},"required":["name","status","configuration"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["aws-pca"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA."},"certificateAuthorityArn":{"type":"string","minLength":1,"description":"The ARN of the AWS Private Certificate Authority to use for issuing certificates."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region where the Private Certificate Authority is located."}},"required":["appConnectionId","certificateAuthorityArn","region"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/aws-pca/{id}":{"get":{"operationId":"getAwsPcaCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["aws-pca"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA."},"certificateAuthorityArn":{"type":"string","minLength":1,"description":"The ARN of the AWS Private Certificate Authority to use for issuing certificates."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region where the Private Certificate Authority is located."}},"required":["appConnectionId","certificateAuthorityArn","region"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAwsPcaCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the AWS Private Certificate Authority Certificate Authority. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The updated status of the AWS Private Certificate Authority Certificate Authority."},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA."},"certificateAuthorityArn":{"type":"string","minLength":1,"description":"The ARN of the AWS Private Certificate Authority to use for issuing certificates."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region where the Private Certificate Authority is located."}},"required":["appConnectionId","certificateAuthorityArn","region"],"additionalProperties":false}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["aws-pca"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA."},"certificateAuthorityArn":{"type":"string","minLength":1,"description":"The ARN of the AWS Private Certificate Authority to use for issuing certificates."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region where the Private Certificate Authority is located."}},"required":["appConnectionId","certificateAuthorityArn","region"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAwsPcaCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["aws-pca"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA."},"certificateAuthorityArn":{"type":"string","minLength":1,"description":"The ARN of the AWS Private Certificate Authority to use for issuing certificates."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region where the Private Certificate Authority is located."}},"required":["appConnectionId","certificateAuthorityArn","region"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/digicert":{"get":{"operationId":"listDigicertCertificateAuthoritiesV1","tags":["PKI Certificate Authorities"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["digicert"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"DigiCert App Connection ID"},"organizationId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"CertCentral Organization ID that will be listed on issued certificates"},"productNameId":{"type":"string","minLength":1,"description":"The DigiCert product name_id used for issuance (e.g. ssl_plus, code_signing, code_signing_ev). Fetch available products from GET /app-connections/digicert/:id/products."},"purpose":{"type":"string","enum":["ssl","code_signing"],"description":"Whether this CA issues SSL/TLS or code-signing certificates (defaults to ssl)"},"verifiedContact":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":128},"lastName":{"type":"string","minLength":1,"maxLength":128},"email":{"type":"string","format":"email","maxLength":255},"jobTitle":{"type":"string","minLength":1,"maxLength":64},"telephone":{"type":"string","minLength":1,"maxLength":32}},"required":["firstName","lastName","email","jobTitle","telephone"],"additionalProperties":false,"description":"Contact info for the user who approves first-time code signing orders for the organization"}},"required":["appConnectionId","organizationId","productNameId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createDigicertCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the DigiCert Certificate Authority to create. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The status of the DigiCert Certificate Authority."},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"DigiCert App Connection ID"},"organizationId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"CertCentral Organization ID that will be listed on issued certificates"},"productNameId":{"type":"string","minLength":1,"description":"The DigiCert product name_id used for issuance (e.g. ssl_plus, code_signing, code_signing_ev). Fetch available products from GET /app-connections/digicert/:id/products."},"purpose":{"type":"string","enum":["ssl","code_signing"],"description":"Whether this CA issues SSL/TLS or code-signing certificates (defaults to ssl)"},"verifiedContact":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":128},"lastName":{"type":"string","minLength":1,"maxLength":128},"email":{"type":"string","format":"email","maxLength":255},"jobTitle":{"type":"string","minLength":1,"maxLength":64},"telephone":{"type":"string","minLength":1,"maxLength":32}},"required":["firstName","lastName","email","jobTitle","telephone"],"additionalProperties":false,"description":"Contact info for the user who approves first-time code signing orders for the organization"}},"required":["appConnectionId","organizationId","productNameId"],"additionalProperties":false}},"required":["name","status","configuration"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["digicert"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"DigiCert App Connection ID"},"organizationId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"CertCentral Organization ID that will be listed on issued certificates"},"productNameId":{"type":"string","minLength":1,"description":"The DigiCert product name_id used for issuance (e.g. ssl_plus, code_signing, code_signing_ev). Fetch available products from GET /app-connections/digicert/:id/products."},"purpose":{"type":"string","enum":["ssl","code_signing"],"description":"Whether this CA issues SSL/TLS or code-signing certificates (defaults to ssl)"},"verifiedContact":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":128},"lastName":{"type":"string","minLength":1,"maxLength":128},"email":{"type":"string","format":"email","maxLength":255},"jobTitle":{"type":"string","minLength":1,"maxLength":64},"telephone":{"type":"string","minLength":1,"maxLength":32}},"required":["firstName","lastName","email","jobTitle","telephone"],"additionalProperties":false,"description":"Contact info for the user who approves first-time code signing orders for the organization"}},"required":["appConnectionId","organizationId","productNameId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/digicert/{id}":{"get":{"operationId":"getDigicertCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["digicert"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"DigiCert App Connection ID"},"organizationId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"CertCentral Organization ID that will be listed on issued certificates"},"productNameId":{"type":"string","minLength":1,"description":"The DigiCert product name_id used for issuance (e.g. ssl_plus, code_signing, code_signing_ev). Fetch available products from GET /app-connections/digicert/:id/products."},"purpose":{"type":"string","enum":["ssl","code_signing"],"description":"Whether this CA issues SSL/TLS or code-signing certificates (defaults to ssl)"},"verifiedContact":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":128},"lastName":{"type":"string","minLength":1,"maxLength":128},"email":{"type":"string","format":"email","maxLength":255},"jobTitle":{"type":"string","minLength":1,"maxLength":64},"telephone":{"type":"string","minLength":1,"maxLength":32}},"required":["firstName","lastName","email","jobTitle","telephone"],"additionalProperties":false,"description":"Contact info for the user who approves first-time code signing orders for the organization"}},"required":["appConnectionId","organizationId","productNameId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateDigicertCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the DigiCert Certificate Authority. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The updated status of the DigiCert Certificate Authority."},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"DigiCert App Connection ID"},"organizationId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"CertCentral Organization ID that will be listed on issued certificates"},"productNameId":{"type":"string","minLength":1,"description":"The DigiCert product name_id used for issuance (e.g. ssl_plus, code_signing, code_signing_ev). Fetch available products from GET /app-connections/digicert/:id/products."},"purpose":{"type":"string","enum":["ssl","code_signing"],"description":"Whether this CA issues SSL/TLS or code-signing certificates (defaults to ssl)"},"verifiedContact":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":128},"lastName":{"type":"string","minLength":1,"maxLength":128},"email":{"type":"string","format":"email","maxLength":255},"jobTitle":{"type":"string","minLength":1,"maxLength":64},"telephone":{"type":"string","minLength":1,"maxLength":32}},"required":["firstName","lastName","email","jobTitle","telephone"],"additionalProperties":false,"description":"Contact info for the user who approves first-time code signing orders for the organization"}},"required":["appConnectionId","organizationId","productNameId"],"additionalProperties":false}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["digicert"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"DigiCert App Connection ID"},"organizationId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"CertCentral Organization ID that will be listed on issued certificates"},"productNameId":{"type":"string","minLength":1,"description":"The DigiCert product name_id used for issuance (e.g. ssl_plus, code_signing, code_signing_ev). Fetch available products from GET /app-connections/digicert/:id/products."},"purpose":{"type":"string","enum":["ssl","code_signing"],"description":"Whether this CA issues SSL/TLS or code-signing certificates (defaults to ssl)"},"verifiedContact":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":128},"lastName":{"type":"string","minLength":1,"maxLength":128},"email":{"type":"string","format":"email","maxLength":255},"jobTitle":{"type":"string","minLength":1,"maxLength":64},"telephone":{"type":"string","minLength":1,"maxLength":32}},"required":["firstName","lastName","email","jobTitle","telephone"],"additionalProperties":false,"description":"Contact info for the user who approves first-time code signing orders for the organization"}},"required":["appConnectionId","organizationId","productNameId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteDigicertCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["digicert"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"DigiCert App Connection ID"},"organizationId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"CertCentral Organization ID that will be listed on issued certificates"},"productNameId":{"type":"string","minLength":1,"description":"The DigiCert product name_id used for issuance (e.g. ssl_plus, code_signing, code_signing_ev). Fetch available products from GET /app-connections/digicert/:id/products."},"purpose":{"type":"string","enum":["ssl","code_signing"],"description":"Whether this CA issues SSL/TLS or code-signing certificates (defaults to ssl)"},"verifiedContact":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":128},"lastName":{"type":"string","minLength":1,"maxLength":128},"email":{"type":"string","format":"email","maxLength":255},"jobTitle":{"type":"string","minLength":1,"maxLength":64},"telephone":{"type":"string","minLength":1,"maxLength":32}},"required":["firstName","lastName","email","jobTitle","telephone"],"additionalProperties":false,"description":"Contact info for the user who approves first-time code signing orders for the organization"}},"required":["appConnectionId","organizationId","productNameId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/godaddy":{"get":{"operationId":"listGodaddyCertificateAuthoritiesV1","tags":["PKI Certificate Authorities"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["godaddy"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"GoDaddy App Connection ID"},"productType":{"type":"string","enum":["DV_SSL"],"description":"The GoDaddy DV product used for issuance (DV_SSL for a single domain)"}},"required":["appConnectionId","productType"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createGodaddyCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the GoDaddy Certificate Authority to create. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The status of the GoDaddy Certificate Authority."},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"GoDaddy App Connection ID"},"productType":{"type":"string","enum":["DV_SSL"],"description":"The GoDaddy DV product used for issuance (DV_SSL for a single domain)"}},"required":["appConnectionId","productType"],"additionalProperties":false}},"required":["name","status","configuration"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["godaddy"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"GoDaddy App Connection ID"},"productType":{"type":"string","enum":["DV_SSL"],"description":"The GoDaddy DV product used for issuance (DV_SSL for a single domain)"}},"required":["appConnectionId","productType"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/godaddy/{id}":{"get":{"operationId":"getGodaddyCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["godaddy"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"GoDaddy App Connection ID"},"productType":{"type":"string","enum":["DV_SSL"],"description":"The GoDaddy DV product used for issuance (DV_SSL for a single domain)"}},"required":["appConnectionId","productType"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateGodaddyCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the GoDaddy Certificate Authority. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The updated status of the GoDaddy Certificate Authority."},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"GoDaddy App Connection ID"},"productType":{"type":"string","enum":["DV_SSL"],"description":"The GoDaddy DV product used for issuance (DV_SSL for a single domain)"}},"required":["appConnectionId","productType"],"additionalProperties":false}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["godaddy"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"GoDaddy App Connection ID"},"productType":{"type":"string","enum":["DV_SSL"],"description":"The GoDaddy DV product used for issuance (DV_SSL for a single domain)"}},"required":["appConnectionId","productType"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteGodaddyCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["godaddy"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"GoDaddy App Connection ID"},"productType":{"type":"string","enum":["DV_SSL"],"description":"The GoDaddy DV product used for issuance (DV_SSL for a single domain)"}},"required":["appConnectionId","productType"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/aws-acm-public-ca":{"get":{"operationId":"listAwsAcmPublicCaCertificateAuthoritiesV1","tags":["PKI Certificate Authorities"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["aws-acm-public-ca"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates."},"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation."},"hostedZoneId":{"type":"string","minLength":1,"description":"The Route 53 hosted zone ID to use for ACM DNS validation CNAME records."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region to use for the ACM API calls."}},"required":["appConnectionId","dnsAppConnectionId","hostedZoneId","region"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAwsAcmPublicCaCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the AWS ACM Public CA Certificate Authority to create. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The status of the AWS ACM Public CA Certificate Authority."},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates."},"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation."},"hostedZoneId":{"type":"string","minLength":1,"description":"The Route 53 hosted zone ID to use for ACM DNS validation CNAME records."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region to use for the ACM API calls."}},"required":["appConnectionId","dnsAppConnectionId","hostedZoneId","region"],"additionalProperties":false}},"required":["name","status","configuration"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["aws-acm-public-ca"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates."},"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation."},"hostedZoneId":{"type":"string","minLength":1,"description":"The Route 53 hosted zone ID to use for ACM DNS validation CNAME records."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region to use for the ACM API calls."}},"required":["appConnectionId","dnsAppConnectionId","hostedZoneId","region"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/aws-acm-public-ca/{id}":{"get":{"operationId":"getAwsAcmPublicCaCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["aws-acm-public-ca"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates."},"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation."},"hostedZoneId":{"type":"string","minLength":1,"description":"The Route 53 hosted zone ID to use for ACM DNS validation CNAME records."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region to use for the ACM API calls."}},"required":["appConnectionId","dnsAppConnectionId","hostedZoneId","region"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAwsAcmPublicCaCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the AWS ACM Public CA Certificate Authority. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The updated status of the AWS ACM Public CA Certificate Authority."},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates."},"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation."},"hostedZoneId":{"type":"string","minLength":1,"description":"The Route 53 hosted zone ID to use for ACM DNS validation CNAME records."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region to use for the ACM API calls."}},"required":["appConnectionId","dnsAppConnectionId","hostedZoneId","region"],"additionalProperties":false}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["aws-acm-public-ca"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates."},"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation."},"hostedZoneId":{"type":"string","minLength":1,"description":"The Route 53 hosted zone ID to use for ACM DNS validation CNAME records."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region to use for the ACM API calls."}},"required":["appConnectionId","dnsAppConnectionId","hostedZoneId","region"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAwsAcmPublicCaCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["aws-acm-public-ca"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates."},"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation."},"hostedZoneId":{"type":"string","minLength":1,"description":"The Route 53 hosted zone ID to use for ACM DNS validation CNAME records."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region to use for the ACM API calls."}},"required":["appConnectionId","dnsAppConnectionId","hostedZoneId","region"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/venafi-tpp":{"get":{"operationId":"listVenafiTppCertificateAuthoritiesV1","tags":["PKI Certificate Authorities"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["venafi-tpp"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The Venafi TPP App Connection ID."},"policyDN":{"type":"string","minLength":1,"description":"The policy folder DN in Venafi TPP (e.g., '\\\\VED\\\\Policy\\\\Certificates')."}},"required":["appConnectionId","policyDN"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createVenafiTppCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Venafi Trust Protection Platform Certificate Authority to create. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The status of the Venafi Trust Protection Platform Certificate Authority."},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The Venafi TPP App Connection ID."},"policyDN":{"type":"string","minLength":1,"description":"The policy folder DN in Venafi TPP (e.g., '\\\\VED\\\\Policy\\\\Certificates')."}},"required":["appConnectionId","policyDN"],"additionalProperties":false}},"required":["name","status","configuration"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["venafi-tpp"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The Venafi TPP App Connection ID."},"policyDN":{"type":"string","minLength":1,"description":"The policy folder DN in Venafi TPP (e.g., '\\\\VED\\\\Policy\\\\Certificates')."}},"required":["appConnectionId","policyDN"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca/venafi-tpp/{id}":{"get":{"operationId":"getVenafiTppCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["venafi-tpp"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The Venafi TPP App Connection ID."},"policyDN":{"type":"string","minLength":1,"description":"The policy folder DN in Venafi TPP (e.g., '\\\\VED\\\\Policy\\\\Certificates')."}},"required":["appConnectionId","policyDN"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateVenafiTppCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Venafi Trust Protection Platform Certificate Authority. Must be slug-friendly."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The updated status of the Venafi Trust Protection Platform Certificate Authority."},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The Venafi TPP App Connection ID."},"policyDN":{"type":"string","minLength":1,"description":"The policy folder DN in Venafi TPP (e.g., '\\\\VED\\\\Policy\\\\Certificates')."}},"required":["appConnectionId","policyDN"],"additionalProperties":false}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["venafi-tpp"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The Venafi TPP App Connection ID."},"policyDN":{"type":"string","minLength":1,"description":"The policy folder DN in Venafi TPP (e.g., '\\\\VED\\\\Policy\\\\Certificates')."}},"required":["appConnectionId","policyDN"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteVenafiTppCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["venafi-tpp"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The Venafi TPP App Connection ID."},"policyDN":{"type":"string","minLength":1,"description":"The policy folder DN in Venafi TPP (e.g., '\\\\VED\\\\Policy\\\\Certificates')."}},"required":["appConnectionId","policyDN"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/ca":{"get":{"operationId":"listCertificateAuthoritiesV1General","tags":["PKI Certificate Authorities"],"description":"Get Certificate Authorities","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateAuthorities":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["internal"]},"configuration":{"type":"object","properties":{"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"default":"","description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"default":"","description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"default":"","description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"default":"","description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"default":"","description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"default":"","description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"nullable":true,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"keySource":{"type":"string","enum":["infisical","hsm"],"description":"Where the CA's signing key is generated and stored. 'infisical' keeps the key in Infisical's KMS; 'hsm' generates and stores the key in the HSM reached through the specified HSM Connector."},"hsmConnectorId":{"type":"string","format":"uuid","description":"The ID of the HSM Connector to generate and store the CA's signing key in. Required when keySource is 'hsm'."},"hsmKeyLabel":{"type":"string","description":"The label of the CA's signing key on the HSM. Not user-supplied: it is the HSM Connector's configured key name prefix followed by a per-CA label built from the CA name and a random 5-character suffix (ca-<name>-<slug>)."},"dn":{"type":"string","maxLength":255,"nullable":true},"parentCaId":{"type":"string","format":"uuid","nullable":true},"serialNumber":{"type":"string","nullable":true},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false,"description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"required":["type","keyAlgorithm"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false},{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["acme"]},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false},{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["azure-ad-cs"]},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false},{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["adcs"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ADCS App Connection ID."},"caName":{"type":"string","minLength":1,"description":"The AD CS certification authority name. Optional: discovered automatically from the CA host when omitted."}},"required":["appConnectionId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false},{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["aws-pca"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Private Certificate Authority (PCA). This connection must have permissions to issue, get, and revoke certificates from the specified PCA."},"certificateAuthorityArn":{"type":"string","minLength":1,"description":"The ARN of the AWS Private Certificate Authority to use for issuing certificates."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region where the Private Certificate Authority is located."}},"required":["appConnectionId","certificateAuthorityArn","region"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false},{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["digicert"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"DigiCert App Connection ID"},"organizationId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"CertCentral Organization ID that will be listed on issued certificates"},"productNameId":{"type":"string","minLength":1,"description":"The DigiCert product name_id used for issuance (e.g. ssl_plus, code_signing, code_signing_ev). Fetch available products from GET /app-connections/digicert/:id/products."},"purpose":{"type":"string","enum":["ssl","code_signing"],"description":"Whether this CA issues SSL/TLS or code-signing certificates (defaults to ssl)"},"verifiedContact":{"type":"object","properties":{"firstName":{"type":"string","minLength":1,"maxLength":128},"lastName":{"type":"string","minLength":1,"maxLength":128},"email":{"type":"string","format":"email","maxLength":255},"jobTitle":{"type":"string","minLength":1,"maxLength":64},"telephone":{"type":"string","minLength":1,"maxLength":32}},"required":["firstName","lastName","email","jobTitle","telephone"],"additionalProperties":false,"description":"Contact info for the user who approves first-time code signing orders for the organization"}},"required":["appConnectionId","organizationId","productNameId"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false},{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["godaddy"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"GoDaddy App Connection ID"},"productType":{"type":"string","enum":["DV_SSL"],"description":"The GoDaddy DV product used for issuance (DV_SSL for a single domain)"}},"required":["appConnectionId","productType"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false},{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["aws-acm-public-ca"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for authenticating with AWS Certificate Manager (ACM). This connection must have permissions to request, describe, export, renew, and delete certificates."},"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the AWS App Connection to use for creating and managing Route 53 CNAME records required for ACM domain validation."},"hostedZoneId":{"type":"string","minLength":1,"description":"The Route 53 hosted zone ID to use for ACM DNS validation CNAME records."},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"],"description":"The AWS region to use for the ACM API calls."}},"required":["appConnectionId","dnsAppConnectionId","hostedZoneId","region"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false},{"type":"object","properties":{"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["venafi-tpp"]},"configuration":{"type":"object","properties":{"appConnectionId":{"type":"string","format":"uuid","description":"The Venafi TPP App Connection ID."},"policyDN":{"type":"string","minLength":1,"description":"The policy folder DN in Venafi TPP (e.g., '\\\\VED\\\\Policy\\\\Certificates')."}},"required":["appConnectionId","policyDN"],"additionalProperties":false}},"required":["name","id","status","type","configuration"],"additionalProperties":false}]}}},"required":["certificateAuthorities"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates":{"post":{"operationId":"createCertificate","tags":["PKI Certificates"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profileId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"csr":{"type":"string","minLength":1,"maxLength":4096},"attributes":{"type":"object","properties":{"commonName":{"type":"string","maxLength":255,"nullable":true},"organization":{"type":"string","maxLength":255,"nullable":true},"organizationalUnit":{"type":"string","maxLength":255,"nullable":true},"country":{"type":"string","maxLength":255,"nullable":true},"state":{"type":"string","maxLength":255,"nullable":true},"locality":{"type":"string","maxLength":255,"nullable":true},"domainComponents":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"maxItems":50,"nullable":true},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]},"maxItems":20},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]},"maxItems":20},"altNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1,"maxLength":255}},"required":["type","value"],"additionalProperties":false},"maxItems":100},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"ttl":{"type":"string","maxLength":32},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"integer","minimum":0,"maximum":255}},"required":["isCA"],"additionalProperties":false},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"value":{"type":"string","minLength":1,"maxLength":4096},"critical":{"type":"boolean"}},"required":["oid"],"additionalProperties":false},"maxItems":10},"notBefore":{"type":"string"},"notAfter":{"type":"string"}},"additionalProperties":false},"removeRootsFromChain":{"anyOf":[{"type":"boolean"},{"type":"string"}],"default":false},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}}},"required":["profileId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"object","properties":{"certificate":{"type":"string"},"issuingCaCertificate":{"type":"string"},"certificateChain":{"type":"string"},"privateKey":{"type":"string"},"serialNumber":{"type":"string"},"certificateId":{"type":"string"}},"required":["certificate","issuingCaCertificate","certificateChain","serialNumber","certificateId"],"additionalProperties":false,"nullable":true},"certificateRequestId":{"type":"string"},"status":{"type":"string","enum":["pending_approval","pending","pending_validation","issued","failed","rejected"]},"message":{"type":"string"}},"required":["certificate","certificateRequestId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates/certificate-requests/{requestId}":{"get":{"operationId":"getCertificateRequest","tags":["PKI Certificates"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"requestId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["pending_approval","pending","pending_validation","issued","failed","rejected"]},"certificate":{"type":"string","nullable":true},"certificateId":{"type":"string","nullable":true},"privateKey":{"type":"string","nullable":true},"serialNumber":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"pendingMessage":{"type":"string","nullable":true},"commonName":{"type":"string","nullable":true},"organization":{"type":"string","nullable":true},"organizationalUnit":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"locality":{"type":"string","nullable":true},"domainComponents":{"type":"array","items":{"type":"string"},"nullable":true},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false,"nullable":true},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","maxLength":4096},"displayValue":{"type":"string","maxLength":4096}},"required":["oid","critical","value"],"additionalProperties":false},"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["status","certificate","certificateId","privateKey","serialNumber","errorMessage","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates/certificate-requests/{requestId}/trigger-validation":{"post":{"operationId":"triggerCertificateRequestValidation","tags":["PKI Certificates"],"description":"Manually ask the issuing CA to re-check validation for a pending certificate request","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"requestId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["pending_approval","pending","pending_validation","issued","failed","rejected"]},"orderStatus":{"type":"string"}},"required":["status"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates/certificate-requests/search":{"post":{"operationId":"searchCertificateRequests","tags":["PKI Certificates"],"description":"Search and filter certificate requests.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"offset":{"type":"number","minimum":0,"default":0},"limit":{"type":"number","minimum":1,"maximum":100,"default":20},"search":{"type":"string"},"status":{"type":"string","enum":["pending_approval","pending","pending_validation","issued","failed","rejected"]},"fromDate":{"type":"string","format":"date-time"},"toDate":{"type":"string","format":"date-time"},"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"applicationId":{"type":"string","format":"uuid","description":"Filter to certificate requests for profiles attached to a specific Application."},"sortBy":{"type":"string"},"sortOrder":{"type":"string","enum":["asc","desc"]},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateRequests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["pending_approval","pending","pending_validation","issued","failed","rejected"]},"commonName":{"type":"string","nullable":true},"altNames":{"type":"string","nullable":true},"profileId":{"type":"string","nullable":true},"profileName":{"type":"string","nullable":true},"caId":{"type":"string","nullable":true},"certificateId":{"type":"string","nullable":true},"approvalRequestId":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"pendingMessage":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"certificate":{"type":"object","properties":{"id":{"type":"string"},"serialNumber":{"type":"string"},"status":{"type":"string"}},"required":["id","serialNumber","status"],"additionalProperties":false,"nullable":true}},"required":["id","status","commonName","altNames","profileId","profileName","caId","certificateId","approvalRequestId","errorMessage","pendingMessage","createdAt","updatedAt","certificate"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["certificateRequests","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates/certificate-requests/{requestId}/cancel":{"post":{"operationId":"cancelCertificateRequest","tags":["PKI Certificates"],"description":"Cancel a pending certificate request.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"requestId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["pending_approval","pending","pending_validation","issued","failed","rejected"]},"cancelled":{"type":"boolean"},"errorMessage":{"type":"string","nullable":true}},"required":["status","cancelled","errorMessage"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates/{id}/renew":{"post":{"operationId":"renewCertificate","tags":["PKI Certificates"],"description":"Renew a certificate. The renewed certificate copies the one being renewed, then applies only the changes supplied here. Profile defaults are not applied.","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"type":"object","properties":{"removeRootsFromChain":{"anyOf":[{"type":"boolean"},{"type":"string"}],"default":false,"description":"Whether to remove the root certificate from the returned certificate chain."},"renewalKeySource":{"type":"string","enum":["new","reuse","csr"],"description":"How the renewed certificate's key pair is handled. 'new' generates a fresh pair, 'reuse' keeps the current one so the renewed certificate carries the same public key, and 'csr' takes the key from a supplied signing request. Defaults to 'new'."},"csr":{"type":"string","minLength":1,"maxLength":4096,"description":"A PEM-encoded certificate signing request to renew from. Its subject, key and extensions take precedence, so only TTL and basic constraints may be set alongside it."},"attributes":{"type":"object","properties":{"commonName":{"type":"string","maxLength":255,"nullable":true},"organization":{"type":"string","maxLength":255,"nullable":true},"organizationalUnit":{"type":"string","maxLength":255,"nullable":true},"country":{"type":"string","maxLength":255,"nullable":true},"state":{"type":"string","maxLength":255,"nullable":true},"locality":{"type":"string","maxLength":255,"nullable":true},"domainComponents":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"maxItems":50,"nullable":true},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]},"maxItems":20},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]},"maxItems":20},"altNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1,"maxLength":255}},"required":["type","value"],"additionalProperties":false},"maxItems":100},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"ttl":{"type":"string","maxLength":32},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"integer","minimum":0,"maximum":255}},"required":["isCA"],"additionalProperties":false},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"value":{"type":"string","minLength":1,"maxLength":4096},"critical":{"type":"boolean"}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"description":"Certificate fields to change on renewal. Anything omitted is copied from the certificate being renewed. Profile defaults are not applied."}},"additionalProperties":false,"nullable":true}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"The ID of the certificate to renew."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string"},"issuingCaCertificate":{"type":"string"},"certificateChain":{"type":"string"},"privateKey":{"type":"string"},"serialNumber":{"type":"string"},"certificateId":{"type":"string"},"certificateRequestId":{"type":"string"}},"required":["certificate","issuingCaCertificate","certificateChain","serialNumber","certificateId","certificateRequestId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates/{id}/config":{"patch":{"operationId":"updateCertificateRenewalConfig","tags":["PKI Certificates"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"renewBeforeDays":{"type":"integer","minimum":1,"maximum":30},"enableAutoRenewal":{"type":"boolean"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"renewBeforeDays":{"type":"number"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates/{id}":{"get":{"operationId":"getCertificate","tags":["PKI Certificates"],"description":"Get certificate","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"The ID of the certificate to get."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"status":{"type":"string"},"serialNumber":{"type":"string"},"friendlyName":{"type":"string"},"commonName":{"type":"string"},"notBefore":{"type":"string","format":"date-time"},"notAfter":{"type":"string","format":"date-time"},"revokedAt":{"type":"string","format":"date-time","nullable":true},"revocationReason":{"type":"number","nullable":true},"altNames":{"type":"string","nullable":true},"caCertId":{"type":"string","format":"uuid","nullable":true},"certificateTemplateId":{"type":"string","format":"uuid","nullable":true},"keyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"extendedKeyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"pkiSubscriberId":{"type":"string","format":"uuid","nullable":true},"profileId":{"type":"string","format":"uuid","nullable":true},"renewBeforeDays":{"type":"number","nullable":true},"renewedFromCertificateId":{"type":"string","format":"uuid","nullable":true},"renewedByCertificateId":{"type":"string","format":"uuid","nullable":true},"renewalError":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","nullable":true},"signatureAlgorithm":{"type":"string","nullable":true},"subjectOrganization":{"type":"string","nullable":true},"subjectOrganizationalUnit":{"type":"string","nullable":true},"subjectCountry":{"type":"string","nullable":true},"subjectState":{"type":"string","nullable":true},"subjectLocality":{"type":"string","nullable":true},"fingerprintSha256":{"type":"string","nullable":true},"fingerprintSha1":{"type":"string","nullable":true},"isCA":{"type":"boolean","nullable":true},"pathLength":{"type":"number","nullable":true},"source":{"type":"string","nullable":true},"discoveryMetadata":{"nullable":true},"externalMetadata":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["aws-acm-public-ca"]},"arn":{"type":"string"},"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"validationMethod":{"type":"string","enum":["DNS"]}},"required":["type","arn","region","validationMethod"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["digicert"]},"orderId":{"type":"integer","exclusiveMinimum":true,"minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","orderId"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["godaddy"]},"certificateId":{"type":"string","minLength":1}},"required":["type","certificateId"],"additionalProperties":false}],"nullable":true,"description":"Identifies this certificate at the provider that issued it, for certificates issued by or linked to an external certificate authority. Null for everything else."},"applicationId":{"type":"string","format":"uuid","nullable":true},"keySource":{"type":"string","default":"infisical"},"hsmConnectorId":{"type":"string","format":"uuid","nullable":true},"hsmKeyLabel":{"type":"string","nullable":true},"hsmPublicKeySpki":{"nullable":true},"subjectDomainComponents":{"type":"string","nullable":true},"orderId":{"type":"string","format":"uuid","default":"00000000-0000-0000-0000-000000000000"},"customExtensions":{"nullable":true},"subject":{"type":"object","properties":{"commonName":{"type":"string"},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"locality":{"type":"string"},"domainComponents":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"fingerprints":{"type":"object","properties":{"sha256":{"type":"string"},"sha1":{"type":"string"}},"required":["sha256"],"additionalProperties":false},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false},"caName":{"type":"string","nullable":true},"caType":{"type":"string","enum":["internal","external"],"nullable":true},"profileName":{"type":"string","nullable":true},"applicationName":{"type":"string","nullable":true},"hasPrivateKey":{"type":"boolean","description":"Whether Infisical holds the private key for this certificate."},"latestRenewalCertificateId":{"type":"string","format":"uuid","nullable":true,"description":"The ID of the newest certificate that has replaced this one through renewal, or null if no newer replacement is available. Revoked certificates are never named, so this is null when this certificate has never been renewed and also when every renewal of it has since been revoked. Use this to follow renewals without walking the chain one certificate at a time."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}}},"required":["id","createdAt","updatedAt","status","serialNumber","friendlyName","commonName","notBefore","notAfter","hasPrivateKey"],"additionalProperties":false}},"required":["certificate"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateCertificate","tags":["PKI Certificates"],"description":"Update certificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255},"value":{"type":"string","maxLength":1020,"default":""}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"The ID of the certificate to get."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false}}},"required":["metadata"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteCertificate","tags":["PKI Certificates"],"description":"Delete certificate. Only expired, discovered, or imported certificates can be deleted.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"The ID of the certificate to delete."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"status":{"type":"string"},"serialNumber":{"type":"string"},"friendlyName":{"type":"string"},"commonName":{"type":"string"},"notBefore":{"type":"string","format":"date-time"},"notAfter":{"type":"string","format":"date-time"},"revokedAt":{"type":"string","format":"date-time","nullable":true},"revocationReason":{"type":"number","nullable":true},"altNames":{"type":"string","nullable":true},"caCertId":{"type":"string","format":"uuid","nullable":true},"certificateTemplateId":{"type":"string","format":"uuid","nullable":true},"keyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"extendedKeyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"pkiSubscriberId":{"type":"string","format":"uuid","nullable":true},"profileId":{"type":"string","format":"uuid","nullable":true},"renewBeforeDays":{"type":"number","nullable":true},"renewedFromCertificateId":{"type":"string","format":"uuid","nullable":true},"renewedByCertificateId":{"type":"string","format":"uuid","nullable":true},"renewalError":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","nullable":true},"signatureAlgorithm":{"type":"string","nullable":true},"subjectOrganization":{"type":"string","nullable":true},"subjectOrganizationalUnit":{"type":"string","nullable":true},"subjectCountry":{"type":"string","nullable":true},"subjectState":{"type":"string","nullable":true},"subjectLocality":{"type":"string","nullable":true},"fingerprintSha256":{"type":"string","nullable":true},"fingerprintSha1":{"type":"string","nullable":true},"isCA":{"type":"boolean","nullable":true},"pathLength":{"type":"number","nullable":true},"source":{"type":"string","nullable":true},"discoveryMetadata":{"nullable":true},"externalMetadata":{"nullable":true},"applicationId":{"type":"string","format":"uuid","nullable":true},"keySource":{"type":"string","default":"infisical"},"hsmConnectorId":{"type":"string","format":"uuid","nullable":true},"hsmKeyLabel":{"type":"string","nullable":true},"hsmPublicKeySpki":{"nullable":true},"subjectDomainComponents":{"type":"string","nullable":true},"orderId":{"type":"string","format":"uuid","default":"00000000-0000-0000-0000-000000000000"},"customExtensions":{"nullable":true}},"required":["id","createdAt","updatedAt","status","serialNumber","friendlyName","commonName","notBefore","notAfter"],"additionalProperties":false}},"required":["certificate"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates/{id}/private-key":{"get":{"operationId":"getCertificatePrivateKey","tags":["PKI Certificates"],"description":"Get certificate private key","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"The ID of the certificate to get."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates/{id}/bundle":{"get":{"operationId":"getCertificateBundle","tags":["PKI Certificates"],"description":"Get certificate bundle including the certificate, chain, and private key.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"The ID of the certificate to get the certificate body and certificate chain for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The certificate body of the certificate."},"certificateChain":{"type":"string","nullable":true,"description":"The certificate chain of the certificate."},"privateKey":{"type":"string","nullable":true,"description":"The private key of the certificate."},"serialNumber":{"type":"string","description":"The serial number of the certificate."}},"required":["certificate","certificateChain","privateKey","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates/import-certificate":{"post":{"operationId":"importCertificate","tags":["PKI Certificates"],"description":"Import certificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"certificatePem":{"type":"string","minLength":1,"description":"The PEM-encoded leaf certificate."},"privateKeyPem":{"type":"string","minLength":1,"description":"Optional PEM-encoded private key associated with the certificate."},"chainPem":{"type":"string","minLength":1,"description":"Optional PEM-encoded chain of intermediate certificates."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the certificate."},"pkiCollectionId":{"type":"string","description":"The ID of the PKI collection to add the certificate to."},"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid","description":"The certificate profile that will manage this certificate's lifecycle. The certificate must satisfy the profile's certificate policy, or the request is rejected with a 400 naming the attributes that failed. Omit to track the certificate without renewal, reissue or revocation."},"externalMetadata":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["digicert"]},"orderId":{"type":"integer","exclusiveMinimum":true,"minimum":-9007199254740991,"maximum":9007199254740991}},"required":["type","orderId"],"additionalProperties":false}],"description":"Identifies this certificate at the provider that issued it. Required when the chosen profile issues from an external certificate authority. For DigiCert, pass the CertCentral order ID as { type: \"digicert\", orderId: 2081714 }."}},"required":["certificatePem"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateId":{"type":"string","format":"uuid","description":"The ID of the imported certificate."},"certificate":{"type":"string","description":"The imported certificate."},"certificateChain":{"type":"string","description":"The certificate chain associated with the imported certificate. Returned only when a chain was supplied at import."},"privateKey":{"type":"string","description":"The PEM-encoded private key associated with the imported certificate. Returned only when a private key was supplied at import."},"serialNumber":{"type":"string","description":"The serial number of the imported certificate."}},"required":["certificateId","certificate","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates/{id}/revoke":{"post":{"operationId":"revokeCertificate","tags":["PKI Certificates"],"description":"Revoke","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"revocationReason":{"type":"string","enum":["UNSPECIFIED","KEY_COMPROMISE","CA_COMPROMISE","AFFILIATION_CHANGED","SUPERSEDED","CESSATION_OF_OPERATION","CERTIFICATE_HOLD","PRIVILEGE_WITHDRAWN","A_A_COMPROMISE"],"description":"The reason for revoking the certificate."}},"required":["revocationReason"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID or SHA-1/SHA-256 thumbprint of the certificate to revoke. Thumbprint colons and casing are ignored."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"serialNumber":{"type":"string","description":"The serial number of the revoked certificate."},"revokedAt":{"type":"string","format":"date-time","description":"The date and time when the certificate was revoked."}},"required":["message","serialNumber","revokedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates/{id}/application":{"post":{"operationId":"assignCertificateToApplication","tags":["PKI Certificates"],"description":"Assign a certificate to an Application. Only certificates that aren't already attached to an Application can be assigned; once attached the binding cannot be moved.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"}},"required":["applicationId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"status":{"type":"string"},"serialNumber":{"type":"string"},"friendlyName":{"type":"string"},"commonName":{"type":"string"},"notBefore":{"type":"string","format":"date-time"},"notAfter":{"type":"string","format":"date-time"},"revokedAt":{"type":"string","format":"date-time","nullable":true},"revocationReason":{"type":"number","nullable":true},"altNames":{"type":"string","nullable":true},"caCertId":{"type":"string","format":"uuid","nullable":true},"certificateTemplateId":{"type":"string","format":"uuid","nullable":true},"keyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"extendedKeyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"pkiSubscriberId":{"type":"string","format":"uuid","nullable":true},"profileId":{"type":"string","format":"uuid","nullable":true},"renewBeforeDays":{"type":"number","nullable":true},"renewedFromCertificateId":{"type":"string","format":"uuid","nullable":true},"renewedByCertificateId":{"type":"string","format":"uuid","nullable":true},"renewalError":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","nullable":true},"signatureAlgorithm":{"type":"string","nullable":true},"subjectOrganization":{"type":"string","nullable":true},"subjectOrganizationalUnit":{"type":"string","nullable":true},"subjectCountry":{"type":"string","nullable":true},"subjectState":{"type":"string","nullable":true},"subjectLocality":{"type":"string","nullable":true},"fingerprintSha256":{"type":"string","nullable":true},"fingerprintSha1":{"type":"string","nullable":true},"isCA":{"type":"boolean","nullable":true},"pathLength":{"type":"number","nullable":true},"source":{"type":"string","nullable":true},"discoveryMetadata":{"nullable":true},"externalMetadata":{"nullable":true},"applicationId":{"type":"string","format":"uuid","nullable":true},"keySource":{"type":"string","default":"infisical"},"hsmConnectorId":{"type":"string","format":"uuid","nullable":true},"hsmKeyLabel":{"type":"string","nullable":true},"hsmPublicKeySpki":{"nullable":true},"subjectDomainComponents":{"type":"string","nullable":true},"orderId":{"type":"string","format":"uuid","default":"00000000-0000-0000-0000-000000000000"},"customExtensions":{"nullable":true}},"required":["id","createdAt","updatedAt","status","serialNumber","friendlyName","commonName","notBefore","notAfter"],"additionalProperties":false}},"required":["certificate"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificates/{id}/certificate":{"get":{"operationId":"getCertificateBody","tags":["PKI Certificates"],"description":"Get certificate body of certificate","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true,"description":"The ID of the certificate to get the certificate body and certificate chain for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The certificate body of the certificate."},"certificateChain":{"type":"string","nullable":true,"description":"The certificate chain of the certificate."},"serialNumber":{"type":"string","description":"The serial number of the certificate."}},"required":["certificate","certificateChain","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificate-policies":{"post":{"operationId":"createCertificatePolicy","tags":["PKI Certificate Policies"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"description":{"type":"string","maxLength":255},"subject":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["common_name","organization","country","state","locality","organizational_unit"]},"allowed":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"required":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"denied":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["domain_component"]},"allowed":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"maxItems":25,"description":"Domain component sequences that are permitted. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"required":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"maxItems":25,"description":"Domain component sequences that are required. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"denied":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"maxItems":25,"description":"Domain component sequences that are rejected, each comma-joined most specific first. A sequence is rejected wherever it appears in the chain, so \"example,com\" rejects DC=example,DC=com and DC=host,DC=example,DC=com alike."}},"required":["type"],"additionalProperties":false}]},"nullable":true},"sans":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"allowed":{"type":"array","items":{"type":"string"}},"required":{"type":"array","items":{"type":"string"}},"denied":{"type":"array","items":{"type":"string"}}},"required":["type"],"additionalProperties":false},"nullable":true},"keyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"required":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"denied":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}}},"additionalProperties":false,"nullable":true},"extendedKeyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"required":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"denied":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}}},"additionalProperties":false,"nullable":true},"algorithms":{"type":"object","properties":{"signature":{"type":"array","items":{"type":"string"},"minItems":1},"keyAlgorithm":{"type":"array","items":{"type":"string"},"minItems":1}},"additionalProperties":false,"nullable":true},"validity":{"type":"object","properties":{"max":{"type":"string"}},"additionalProperties":false,"nullable":true},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"string","enum":["allowed","required","denied"]},"maxPathLength":{"type":"integer","minimum":-1}},"additionalProperties":false,"nullable":true},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"string","enum":["critical","not_critical"]},"allowed":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension may take, with * as a wildcard. Use * on its own to accept any value. Omit to place no allow-list constraint on the value."},"required":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must match, with * as a wildcard. Setting any required pattern also makes the extension mandatory on every request."},"denied":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must not take, with * as a wildcard. A denied match is rejected even when an allowed pattern also matches."}},"required":["oid"],"additionalProperties":false},"nullable":true,"description":"Rules for custom X.509 extensions, one per OID. Omit the field to leave custom extensions unconstrained; send an empty array to forbid them entirely."}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificatePolicy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9-_]+$"},"description":{"type":"string","maxLength":1000,"nullable":true},"subject":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["common_name","organization","country","state","locality","organizational_unit"]},"allowed":{"type":"array","items":{"type":"string"}},"required":{"type":"array","items":{"type":"string"}},"denied":{"type":"array","items":{"type":"string"}}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["domain_component"]},"allowed":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are permitted. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"required":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are required. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"denied":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are rejected, each comma-joined most specific first. A sequence is rejected wherever it appears in the chain, so \"example,com\" rejects DC=example,DC=com and DC=host,DC=example,DC=com alike."}},"required":["type"],"additionalProperties":false}]}},"sans":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"allowed":{"type":"array","items":{"type":"string","minLength":1}},"required":{"type":"array","items":{"type":"string","minLength":1}},"denied":{"type":"array","items":{"type":"string","minLength":1}}},"required":["type"],"additionalProperties":false}},"keyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"required":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"denied":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}}},"additionalProperties":false},"extendedKeyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"required":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"denied":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}}},"additionalProperties":false},"algorithms":{"type":"object","properties":{"signature":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"keyAlgorithm":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"additionalProperties":false},"validity":{"type":"object","properties":{"max":{"type":"string","pattern":"^\\d+[dhmy]$"}},"additionalProperties":false},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"string","enum":["allowed","required","denied"]},"maxPathLength":{"type":"integer","minimum":-1}},"additionalProperties":false,"nullable":true},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"string","enum":["critical","not_critical"]},"allowed":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension may take, with * as a wildcard. Use * on its own to accept any value. Omit to place no allow-list constraint on the value."},"required":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must match, with * as a wildcard. Setting any required pattern also makes the extension mandatory on every request."},"denied":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must not take, with * as a wildcard. A denied match is rejected even when an allowed pattern also matches."}},"required":["oid"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificatePolicy"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listCertificatePolicies","tags":["PKI Certificate Policies"],"parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"string"},"in":"query","name":"search","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificatePolicies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9-_]+$"},"description":{"type":"string","maxLength":1000,"nullable":true},"subject":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["common_name","organization","country","state","locality","organizational_unit"]},"allowed":{"type":"array","items":{"type":"string"}},"required":{"type":"array","items":{"type":"string"}},"denied":{"type":"array","items":{"type":"string"}}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["domain_component"]},"allowed":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are permitted. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"required":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are required. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"denied":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are rejected, each comma-joined most specific first. A sequence is rejected wherever it appears in the chain, so \"example,com\" rejects DC=example,DC=com and DC=host,DC=example,DC=com alike."}},"required":["type"],"additionalProperties":false}]}},"sans":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"allowed":{"type":"array","items":{"type":"string","minLength":1}},"required":{"type":"array","items":{"type":"string","minLength":1}},"denied":{"type":"array","items":{"type":"string","minLength":1}}},"required":["type"],"additionalProperties":false}},"keyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"required":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"denied":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}}},"additionalProperties":false},"extendedKeyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"required":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"denied":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}}},"additionalProperties":false},"algorithms":{"type":"object","properties":{"signature":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"keyAlgorithm":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"additionalProperties":false},"validity":{"type":"object","properties":{"max":{"type":"string","pattern":"^\\d+[dhmy]$"}},"additionalProperties":false},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"string","enum":["allowed","required","denied"]},"maxPathLength":{"type":"integer","minimum":-1}},"additionalProperties":false,"nullable":true},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"string","enum":["critical","not_critical"]},"allowed":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension may take, with * as a wildcard. Use * on its own to accept any value. Omit to place no allow-list constraint on the value."},"required":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must match, with * as a wildcard. Setting any required pattern also makes the extension mandatory on every request."},"denied":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must not take, with * as a wildcard. A denied match is rejected even when an allowed pattern also matches."}},"required":["oid"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["certificatePolicies","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificate-policies/{id}":{"get":{"operationId":"getCertificatePolicy","tags":["PKI Certificate Policies"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"applicationId","required":false},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificatePolicy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9-_]+$"},"description":{"type":"string","maxLength":1000,"nullable":true},"subject":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["common_name","organization","country","state","locality","organizational_unit"]},"allowed":{"type":"array","items":{"type":"string"}},"required":{"type":"array","items":{"type":"string"}},"denied":{"type":"array","items":{"type":"string"}}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["domain_component"]},"allowed":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are permitted. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"required":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are required. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"denied":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are rejected, each comma-joined most specific first. A sequence is rejected wherever it appears in the chain, so \"example,com\" rejects DC=example,DC=com and DC=host,DC=example,DC=com alike."}},"required":["type"],"additionalProperties":false}]}},"sans":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"allowed":{"type":"array","items":{"type":"string","minLength":1}},"required":{"type":"array","items":{"type":"string","minLength":1}},"denied":{"type":"array","items":{"type":"string","minLength":1}}},"required":["type"],"additionalProperties":false}},"keyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"required":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"denied":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}}},"additionalProperties":false},"extendedKeyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"required":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"denied":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}}},"additionalProperties":false},"algorithms":{"type":"object","properties":{"signature":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"keyAlgorithm":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"additionalProperties":false},"validity":{"type":"object","properties":{"max":{"type":"string","pattern":"^\\d+[dhmy]$"}},"additionalProperties":false},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"string","enum":["allowed","required","denied"]},"maxPathLength":{"type":"integer","minimum":-1}},"additionalProperties":false,"nullable":true},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"string","enum":["critical","not_critical"]},"allowed":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension may take, with * as a wildcard. Use * on its own to accept any value. Omit to place no allow-list constraint on the value."},"required":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must match, with * as a wildcard. Setting any required pattern also makes the extension mandatory on every request."},"denied":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must not take, with * as a wildcard. A denied match is rejected even when an allowed pattern also matches."}},"required":["oid"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificatePolicy"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateCertificatePolicy","tags":["PKI Certificate Policies"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"description":{"type":"string","maxLength":255},"subject":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["common_name","organization","country","state","locality","organizational_unit"]},"allowed":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"required":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"denied":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["domain_component"]},"allowed":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"maxItems":25,"description":"Domain component sequences that are permitted. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"required":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"maxItems":25,"description":"Domain component sequences that are required. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"denied":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"maxItems":25,"description":"Domain component sequences that are rejected, each comma-joined most specific first. A sequence is rejected wherever it appears in the chain, so \"example,com\" rejects DC=example,DC=com and DC=host,DC=example,DC=com alike."}},"required":["type"],"additionalProperties":false}]},"nullable":true},"sans":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"allowed":{"type":"array","items":{"type":"string"}},"required":{"type":"array","items":{"type":"string"}},"denied":{"type":"array","items":{"type":"string"}}},"required":["type"],"additionalProperties":false},"nullable":true},"keyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"required":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"denied":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}}},"additionalProperties":false,"nullable":true},"extendedKeyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"required":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"denied":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}}},"additionalProperties":false,"nullable":true},"algorithms":{"type":"object","properties":{"signature":{"type":"array","items":{"type":"string"},"minItems":1},"keyAlgorithm":{"type":"array","items":{"type":"string"},"minItems":1}},"additionalProperties":false,"nullable":true},"validity":{"type":"object","properties":{"max":{"type":"string"}},"additionalProperties":false,"nullable":true},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"string","enum":["allowed","required","denied"]},"maxPathLength":{"type":"integer","minimum":-1}},"additionalProperties":false,"nullable":true},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"string","enum":["critical","not_critical"]},"allowed":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension may take, with * as a wildcard. Use * on its own to accept any value. Omit to place no allow-list constraint on the value."},"required":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must match, with * as a wildcard. Setting any required pattern also makes the extension mandatory on every request."},"denied":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must not take, with * as a wildcard. A denied match is rejected even when an allowed pattern also matches."}},"required":["oid"],"additionalProperties":false},"nullable":true,"description":"Rules for custom X.509 extensions, one per OID. Omit the field to leave custom extensions unconstrained; send an empty array to forbid them entirely."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificatePolicy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9-_]+$"},"description":{"type":"string","maxLength":1000,"nullable":true},"subject":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["common_name","organization","country","state","locality","organizational_unit"]},"allowed":{"type":"array","items":{"type":"string"}},"required":{"type":"array","items":{"type":"string"}},"denied":{"type":"array","items":{"type":"string"}}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["domain_component"]},"allowed":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are permitted. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"required":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are required. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"denied":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are rejected, each comma-joined most specific first. A sequence is rejected wherever it appears in the chain, so \"example,com\" rejects DC=example,DC=com and DC=host,DC=example,DC=com alike."}},"required":["type"],"additionalProperties":false}]}},"sans":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"allowed":{"type":"array","items":{"type":"string","minLength":1}},"required":{"type":"array","items":{"type":"string","minLength":1}},"denied":{"type":"array","items":{"type":"string","minLength":1}}},"required":["type"],"additionalProperties":false}},"keyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"required":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"denied":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}}},"additionalProperties":false},"extendedKeyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"required":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"denied":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}}},"additionalProperties":false},"algorithms":{"type":"object","properties":{"signature":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"keyAlgorithm":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"additionalProperties":false},"validity":{"type":"object","properties":{"max":{"type":"string","pattern":"^\\d+[dhmy]$"}},"additionalProperties":false},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"string","enum":["allowed","required","denied"]},"maxPathLength":{"type":"integer","minimum":-1}},"additionalProperties":false,"nullable":true},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"string","enum":["critical","not_critical"]},"allowed":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension may take, with * as a wildcard. Use * on its own to accept any value. Omit to place no allow-list constraint on the value."},"required":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must match, with * as a wildcard. Setting any required pattern also makes the extension mandatory on every request."},"denied":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must not take, with * as a wildcard. A denied match is rejected even when an allowed pattern also matches."}},"required":["oid"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificatePolicy"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteCertificatePolicy","tags":["PKI Certificate Policies"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificatePolicy":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9-_]+$"},"description":{"type":"string","maxLength":1000,"nullable":true},"subject":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["common_name","organization","country","state","locality","organizational_unit"]},"allowed":{"type":"array","items":{"type":"string"}},"required":{"type":"array","items":{"type":"string"}},"denied":{"type":"array","items":{"type":"string"}}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["domain_component"]},"allowed":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are permitted. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"required":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are required. Each entry is one sequence, its components comma-joined most specific first: \"corp,example,com\" matches DC=corp,DC=example,DC=com. A request matches a sequence only when its components line up position by position, so the same labels in another order do not match."},"denied":{"type":"array","items":{"type":"string"},"description":"Domain component sequences that are rejected, each comma-joined most specific first. A sequence is rejected wherever it appears in the chain, so \"example,com\" rejects DC=example,DC=com and DC=host,DC=example,DC=com alike."}},"required":["type"],"additionalProperties":false}]}},"sans":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"allowed":{"type":"array","items":{"type":"string","minLength":1}},"required":{"type":"array","items":{"type":"string","minLength":1}},"denied":{"type":"array","items":{"type":"string","minLength":1}}},"required":["type"],"additionalProperties":false}},"keyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"required":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"denied":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}}},"additionalProperties":false},"extendedKeyUsages":{"type":"object","properties":{"allowed":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"required":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"denied":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}}},"additionalProperties":false},"algorithms":{"type":"object","properties":{"signature":{"type":"array","items":{"type":"string","minLength":1},"minItems":1},"keyAlgorithm":{"type":"array","items":{"type":"string","minLength":1},"minItems":1}},"additionalProperties":false},"validity":{"type":"object","properties":{"max":{"type":"string","pattern":"^\\d+[dhmy]$"}},"additionalProperties":false},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"string","enum":["allowed","required","denied"]},"maxPathLength":{"type":"integer","minimum":-1}},"additionalProperties":false,"nullable":true},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"string","enum":["critical","not_critical"]},"allowed":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension may take, with * as a wildcard. Use * on its own to accept any value. Omit to place no allow-list constraint on the value."},"required":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must match, with * as a wildcard. Setting any required pattern also makes the extension mandatory on every request."},"denied":{"type":"array","items":{"type":"string","minLength":1,"maxLength":4096},"description":"Value patterns this extension must not take, with * as a wildcard. A denied match is rejected even when an allowed pattern also matches."}},"required":["oid"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificatePolicy"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificate-profiles":{"post":{"operationId":"createCertificateProfile","tags":["PKI Certificate Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caId":{"type":"string","format":"uuid"},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-z0-9-]+$"},"description":{"type":"string","maxLength":255},"issuerType":{"type":"string","enum":["ca","self-signed"],"default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"integer","exclusiveMinimum":true,"minimum":0},"commonName":{"type":"string","maxLength":255},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"integer","minimum":0}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string","maxLength":255},"organizationalUnit":{"type":"string","maxLength":255},"country":{"type":"string","maxLength":255},"state":{"type":"string","maxLength":255},"locality":{"type":"string","maxLength":255},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"maxItems":50},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true}},"required":["certificatePolicyId","slug"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateProfile":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid","nullable":true},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"enrollmentType":{"type":"string"},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"issuerType":{"type":"string","default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"number"},"commonName":{"type":"string"},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"locality":{"type":"string"},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string"}},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true}},"required":["id","certificatePolicyId","slug","enrollmentType","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificateProfile"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listCertificateProfiles","tags":["PKI Certificate Profiles"],"parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"string"},"in":"query","name":"search","required":false},{"schema":{"type":"string","enum":["api","est","acme","scep"]},"in":"query","name":"enrollmentType","required":false},{"schema":{"type":"string","enum":["ca","self-signed"]},"in":"query","name":"issuerType","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"caId","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"applicationId","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid","nullable":true},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"enrollmentType":{"type":"string"},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"issuerType":{"type":"string","default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"number"},"commonName":{"type":"string"},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"locality":{"type":"string"},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string"}},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true},"certificateAuthority":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"name":{"type":"string"},"isExternal":{"type":"boolean"},"externalType":{"type":"string","nullable":true},"productNameId":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","nullable":true}},"required":["id","status","name"],"additionalProperties":false},"metrics":{"type":"object","properties":{"profileId":{"type":"string"},"totalCertificates":{"type":"number"},"activeCertificates":{"type":"number"},"expiredCertificates":{"type":"number"},"expiringCertificates":{"type":"number"},"revokedCertificates":{"type":"number"}},"required":["profileId","totalCertificates","activeCertificates","expiredCertificates","expiringCertificates","revokedCertificates"],"additionalProperties":false},"estConfig":{"type":"object","properties":{"id":{"type":"string"},"disableBootstrapCaValidation":{"type":"boolean"},"passphrase":{"type":"string"},"caChain":{"type":"string"}},"required":["id","disableBootstrapCaValidation"],"additionalProperties":false},"apiConfig":{"type":"object","properties":{"id":{"type":"string"},"autoRenew":{"type":"boolean"},"renewBeforeDays":{"type":"number"}},"required":["id","autoRenew"],"additionalProperties":false},"acmeConfig":{"type":"object","properties":{"id":{"type":"string"},"directoryUrl":{"type":"string"},"skipDnsOwnershipVerification":{"type":"boolean"},"skipEabBinding":{"type":"boolean"}},"required":["id","directoryUrl"],"additionalProperties":false},"scepConfig":{"type":"object","properties":{"id":{"type":"string"},"scepEndpointUrl":{"type":"string"},"raCertificatePem":{"type":"string"},"raCertExpiresAt":{"type":"string","format":"date-time"},"includeCaCertInResponse":{"type":"boolean"},"allowCertBasedRenewal":{"type":"boolean"},"challengeType":{"type":"string"},"challengeEndpointUrl":{"type":"string"},"dynamicChallengeExpiryMinutes":{"type":"number"},"dynamicChallengeMaxPending":{"type":"number"}},"required":["id","scepEndpointUrl","raCertificatePem","raCertExpiresAt","includeCaCertInResponse","allowCertBasedRenewal","challengeType"],"additionalProperties":false}},"required":["id","certificatePolicyId","slug","enrollmentType","createdAt","updatedAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["certificateProfiles","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificate-profiles/{id}":{"get":{"operationId":"getCertificateProfile","tags":["PKI Certificate Profiles"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateProfile":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid","nullable":true},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"enrollmentType":{"type":"string"},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"issuerType":{"type":"string","default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"number"},"commonName":{"type":"string"},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"locality":{"type":"string"},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string"}},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true},"certificateAuthority":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"name":{"type":"string"},"isExternal":{"type":"boolean"},"externalType":{"type":"string","nullable":true},"productNameId":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","nullable":true}},"required":["id","status","name"],"additionalProperties":false},"certificatePolicy":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}},"required":["id","name"],"additionalProperties":false},"estConfig":{"type":"object","properties":{"id":{"type":"string"},"disableBootstrapCaValidation":{"type":"boolean"},"caChain":{"type":"string"}},"required":["id","disableBootstrapCaValidation"],"additionalProperties":false},"apiConfig":{"type":"object","properties":{"id":{"type":"string"},"autoRenew":{"type":"boolean"},"renewBeforeDays":{"type":"number"}},"required":["id","autoRenew"],"additionalProperties":false},"acmeConfig":{"type":"object","properties":{"id":{"type":"string"},"directoryUrl":{"type":"string"},"skipDnsOwnershipVerification":{"type":"boolean"},"skipEabBinding":{"type":"boolean"}},"required":["id","directoryUrl"],"additionalProperties":false},"scepConfig":{"type":"object","properties":{"id":{"type":"string"},"scepEndpointUrl":{"type":"string"},"raCertificatePem":{"type":"string"},"raCertExpiresAt":{"type":"string","format":"date-time"},"includeCaCertInResponse":{"type":"boolean"},"allowCertBasedRenewal":{"type":"boolean"},"challengeType":{"type":"string"},"challengeEndpointUrl":{"type":"string"},"dynamicChallengeExpiryMinutes":{"type":"number"},"dynamicChallengeMaxPending":{"type":"number"}},"required":["id","scepEndpointUrl","raCertificatePem","raCertExpiresAt","includeCaCertInResponse","allowCertBasedRenewal","challengeType"],"additionalProperties":false}},"required":["id","certificatePolicyId","slug","enrollmentType","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificateProfile"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateCertificateProfile","tags":["PKI Certificate Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-z0-9-]+$"},"description":{"type":"string","maxLength":255,"nullable":true},"issuerType":{"type":"string","enum":["ca","self-signed"]},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"integer","exclusiveMinimum":true,"minimum":0},"commonName":{"type":"string","maxLength":255},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"integer","minimum":0}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string","maxLength":255},"organizationalUnit":{"type":"string","maxLength":255},"country":{"type":"string","maxLength":255},"state":{"type":"string","maxLength":255},"locality":{"type":"string","maxLength":255},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"maxItems":50},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateProfile":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid","nullable":true},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"enrollmentType":{"type":"string"},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"issuerType":{"type":"string","default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"number"},"commonName":{"type":"string"},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"locality":{"type":"string"},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string"}},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true}},"required":["id","certificatePolicyId","slug","enrollmentType","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificateProfile"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteCertificateProfile","tags":["PKI Certificate Profiles"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateProfile":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid","nullable":true},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"enrollmentType":{"type":"string"},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"issuerType":{"type":"string","default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"number"},"commonName":{"type":"string"},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"locality":{"type":"string"},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string"}},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true}},"required":["id","certificatePolicyId","slug","enrollmentType","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificateProfile"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificate-profiles/slug/{slug}":{"get":{"operationId":"getCertificateProfileBySlug","tags":["PKI Certificate Profiles"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"slug","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateProfile":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid","nullable":true},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"enrollmentType":{"type":"string"},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"issuerType":{"type":"string","default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"number"},"commonName":{"type":"string"},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"locality":{"type":"string"},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string"}},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true}},"required":["id","certificatePolicyId","slug","enrollmentType","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificateProfile"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificate-profiles/{id}/certificates":{"get":{"operationId":"listCertificateProfileCertificates","tags":["PKI Certificate Profiles"],"parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"string","enum":["active","expired","revoked","renewed"]},"in":"query","name":"status","required":false},{"schema":{"type":"string"},"in":"query","name":"search","required":false},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"serialNumber":{"type":"string"},"cn":{"type":"string"},"status":{"type":"string"},"notBefore":{"type":"string","format":"date-time"},"notAfter":{"type":"string","format":"date-time"},"revokedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"}},"required":["id","serialNumber","cn","status","notBefore","notAfter","createdAt"],"additionalProperties":false}}},"required":["certificates"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificate-profiles/{id}/certificates/latest-active-bundle":{"get":{"operationId":"getCertificateProfileLatestActiveBundle","tags":["PKI Certificate Profiles"],"description":"Get latest active certificate bundle for a profile","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","nullable":true},"certificateChain":{"type":"string","nullable":true},"privateKey":{"type":"string","nullable":true},"serialNumber":{"type":"string","nullable":true}},"required":["certificate","certificateChain","privateKey","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificate-profiles/{id}/acme/eab-secret/reveal":{"get":{"operationId":"revealCertificateProfileAcmeEabSecret","tags":["PKI Certificate Profiles"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"eabKid":{"type":"string"},"eabSecret":{"type":"string"}},"required":["eabKid","eabSecret"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/alerts":{"post":{"operationId":"createPkiAlertV1","tags":["PKI Alerting"],"description":"Deprecated: legacy PKI alerts can no longer be created. Use the alerts API (/api/v1/alerts) instead.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"description":{"type":"string","maxLength":1000},"eventType":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"alertBefore":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"enabled":{"type":"boolean","default":true},"notificationConfig":{"type":"object","properties":{"enableDailyNotification":{"type":"boolean","default":false}},"additionalProperties":false,"nullable":true},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"channelType":{"type":"string","enum":["email","webhook","slack","pagerduty"]},"config":{"anyOf":[{"type":"object","properties":{"recipients":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"maxItems":10}},"required":["recipients"],"additionalProperties":false},{"type":"object","properties":{"url":{"type":"string","format":"uri"},"signingSecret":{"type":"string","maxLength":256,"nullable":true}},"required":["url"],"additionalProperties":false},{"type":"object","properties":{"webhookUrl":{"type":"string","format":"uri"}},"required":["webhookUrl"],"additionalProperties":false},{"type":"object","properties":{"integrationKey":{"type":"string"}},"required":["integrationKey"],"additionalProperties":false}]},"enabled":{"type":"boolean","default":true}},"required":["channelType","config"],"additionalProperties":false},"minItems":1,"maxItems":10},"applicationId":{"type":"string","format":"uuid","description":"Optional Application this alert is scoped to"}},"required":["name","eventType","filters","channels"],"additionalProperties":false}}}},"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"alert":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"eventType":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"alertBefore":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"enabled":{"type":"boolean"},"applicationId":{"type":"string","format":"uuid","nullable":true},"notificationConfig":{"type":"object","properties":{"enableDailyNotification":{"type":"boolean","default":false}},"additionalProperties":false,"nullable":true},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"channelType":{"type":"string","enum":["email","webhook","slack","pagerduty"]},"config":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","channelType","config","enabled","createdAt","updatedAt"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","description","eventType","filters","enabled","applicationId","notificationConfig","channels","createdAt","updatedAt"],"additionalProperties":false}},"required":["alert"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listPkiAlertsV1","tags":["PKI Alerting"],"description":"Deprecated: application alerts are managed with the alerts API (/api/v1/alerts). List PKI alerts.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"applicationId","required":false},{"schema":{"type":"string"},"in":"query","name":"search","required":false},{"schema":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"in":"query","name":"eventType","required":false},{"schema":{"type":"boolean"},"in":"query","name":"enabled","required":false},{"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"alerts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"eventType":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"alertBefore":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"enabled":{"type":"boolean"},"applicationId":{"type":"string","format":"uuid","nullable":true},"notificationConfig":{"type":"object","properties":{"enableDailyNotification":{"type":"boolean","default":false}},"additionalProperties":false,"nullable":true},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"channelType":{"type":"string","enum":["email","webhook","slack","pagerduty"]},"config":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","channelType","config","enabled","createdAt","updatedAt"],"additionalProperties":false}},"lastRun":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["success","failed"]},"error":{"type":"string","nullable":true}},"required":["timestamp","status","error"],"additionalProperties":false,"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","description","eventType","filters","enabled","applicationId","notificationConfig","channels","lastRun","createdAt","updatedAt"],"additionalProperties":false}},"total":{"type":"number"}},"required":["alerts","total"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/alerts/{alertId}":{"get":{"operationId":"getPkiAlertV1","tags":["PKI Alerting"],"description":"Deprecated: application alerts are managed with the alerts API (/api/v1/alerts). Get a PKI alert by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"alertId","required":true,"description":"Alert ID"}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"alert":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"eventType":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"alertBefore":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"enabled":{"type":"boolean"},"applicationId":{"type":"string","format":"uuid","nullable":true},"notificationConfig":{"type":"object","properties":{"enableDailyNotification":{"type":"boolean","default":false}},"additionalProperties":false,"nullable":true},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"channelType":{"type":"string","enum":["email","webhook","slack","pagerduty"]},"config":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","channelType","config","enabled","createdAt","updatedAt"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","description","eventType","filters","enabled","applicationId","notificationConfig","channels","createdAt","updatedAt"],"additionalProperties":false}},"required":["alert"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePkiAlertV1","tags":["PKI Alerting"],"description":"Deprecated: legacy PKI alerts can no longer be edited. Use the alerts API (/api/v1/alerts) instead.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"description":{"type":"string","maxLength":1000},"eventType":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"alertBefore":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"enabled":{"type":"boolean","default":true},"notificationConfig":{"type":"object","properties":{"enableDailyNotification":{"type":"boolean","default":false}},"additionalProperties":false,"nullable":true},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"channelType":{"type":"string","enum":["email","webhook","slack","pagerduty"]},"config":{"anyOf":[{"type":"object","properties":{"recipients":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"maxItems":10}},"required":["recipients"],"additionalProperties":false},{"type":"object","properties":{"url":{"type":"string","format":"uri"},"signingSecret":{"type":"string","maxLength":256,"nullable":true}},"required":["url"],"additionalProperties":false},{"type":"object","properties":{"webhookUrl":{"type":"string","format":"uri"}},"required":["webhookUrl"],"additionalProperties":false},{"type":"object","properties":{"integrationKey":{"type":"string"}},"required":["integrationKey"],"additionalProperties":false}]},"enabled":{"type":"boolean","default":true}},"required":["channelType","config"],"additionalProperties":false},"minItems":1,"maxItems":10}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"alertId","required":true,"description":"Alert ID"}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"alert":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"eventType":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"alertBefore":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"enabled":{"type":"boolean"},"applicationId":{"type":"string","format":"uuid","nullable":true},"notificationConfig":{"type":"object","properties":{"enableDailyNotification":{"type":"boolean","default":false}},"additionalProperties":false,"nullable":true},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"channelType":{"type":"string","enum":["email","webhook","slack","pagerduty"]},"config":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","channelType","config","enabled","createdAt","updatedAt"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","description","eventType","filters","enabled","applicationId","notificationConfig","channels","createdAt","updatedAt"],"additionalProperties":false}},"required":["alert"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deletePkiAlertV1","tags":["PKI Alerting"],"description":"Deprecated: application alerts are managed with the alerts API (/api/v1/alerts). Delete a PKI alert.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"alertId","required":true,"description":"Alert ID"}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"alert":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"eventType":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"alertBefore":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"enabled":{"type":"boolean"},"applicationId":{"type":"string","format":"uuid","nullable":true},"notificationConfig":{"type":"object","properties":{"enableDailyNotification":{"type":"boolean","default":false}},"additionalProperties":false,"nullable":true},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"channelType":{"type":"string","enum":["email","webhook","slack","pagerduty"]},"config":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","channelType","config","enabled","createdAt","updatedAt"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","description","eventType","filters","enabled","applicationId","notificationConfig","channels","createdAt","updatedAt"],"additionalProperties":false}},"required":["alert"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/alerts/{alertId}/certificates":{"get":{"tags":["PKI Alerting"],"description":"List certificates that match an alert's filter rules","parameters":[{"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"alertId","required":true,"description":"Alert ID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"serialNumber":{"type":"string"},"commonName":{"type":"string"},"san":{"type":"array","items":{"type":"string"}},"profileName":{"type":"string","nullable":true},"enrollmentType":{"type":"string","nullable":true},"notBefore":{"type":"string","format":"date-time"},"notAfter":{"type":"string","format":"date-time"},"status":{"type":"string"}},"required":["id","serialNumber","commonName","san","profileName","enrollmentType","notBefore","notAfter","status"],"additionalProperties":false}},"total":{"type":"number"}},"required":["certificates","total"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/alerts/preview/certificates":{"post":{"operationId":"previewPkiAlertCertificatesV1","tags":["PKI Alerting"],"description":"Preview certificates that would match the given filter rules","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"alertBefore":{"type":"string","description":"Alert timing (e.g., '30d', '1w'). Required for expiration previews, omit for other event types."},"limit":{"type":"number","minimum":1,"maximum":100,"default":20},"offset":{"type":"number","minimum":0,"default":0}},"required":["filters"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"serialNumber":{"type":"string"},"commonName":{"type":"string"},"san":{"type":"array","items":{"type":"string"}},"profileName":{"type":"string","nullable":true},"enrollmentType":{"type":"string","nullable":true},"notBefore":{"type":"string","format":"date-time"},"notAfter":{"type":"string","format":"date-time"},"status":{"type":"string"}},"required":["id","serialNumber","commonName","san","profileName","enrollmentType","notBefore","notAfter","status"],"additionalProperties":false}},"total":{"type":"number"}},"required":["certificates","total"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications":{"post":{"operationId":"createPkiApplication","tags":["PKI Applications"],"description":"Create an application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"description":{"type":"string","maxLength":256},"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"application":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"required":["application"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listPkiApplications","tags":["PKI Applications"],"description":"List applications.","parameters":[{"schema":{"type":"string"},"in":"query","name":"search","required":false},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"allOf":[{"anyOf":[{"not":{}},{"type":"string"}]},{"anyOf":[{"not":{}},{"type":"array","items":{"type":"string","format":"uuid"}}]}]},"in":"query","name":"applicationIds","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"applications":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"profileCount":{"type":"integer","minimum":0},"memberCount":{"type":"integer","minimum":0},"certificateCount":{"type":"integer","minimum":0}},"required":["id","name","createdAt","updatedAt","profileCount","memberCount","certificateCount"],"additionalProperties":false}},"total":{"type":"integer","minimum":0}},"required":["applications","total"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}":{"get":{"operationId":"getPkiApplication","tags":["PKI Applications"],"description":"Get an application by id.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"application":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"required":["application"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePkiApplication","tags":["PKI Applications"],"description":"Update an application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"description":{"type":"string","maxLength":256,"nullable":true}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"application":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"required":["application"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deletePkiApplication","tags":["PKI Applications"],"description":"Delete an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"application":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"required":["application"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/by-name/{name}":{"get":{"operationId":"getPkiApplicationByName","tags":["PKI Applications"],"description":"Get an application by name.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":64},"in":"path","name":"name","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"application":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"required":["application"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/permissions":{"get":{"operationId":"getPkiApplicationPermissions","tags":["PKI Applications"],"description":"Get the actor's effective resource permissions on this application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"permissions":{"type":"array"},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"actorUserId":{"type":"string","nullable":true},"actorIdentityId":{"type":"string","nullable":true},"actorGroupId":{"type":"string","nullable":true},"roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"customRoleSlug":{"type":"string","nullable":true}},"required":["role"],"additionalProperties":false}}},"required":["id","roles"],"additionalProperties":false}}},"required":["permissions","memberships"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/profiles":{"get":{"operationId":"listPkiApplicationProfiles","tags":["PKI Applications"],"description":"List profiles attached to an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"},"profileSlug":{"type":"string"},"profileDescription":{"type":"string","nullable":true},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["applicationId","profileId","profileSlug","createdAt","updatedAt"],"additionalProperties":false}}},"required":["profiles"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"attachPkiApplicationProfiles","tags":["PKI Applications"],"description":"Attach one or more profiles to an application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1}},"required":["profileIds"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"},"profileSlug":{"type":"string"},"profileDescription":{"type":"string","nullable":true},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["applicationId","profileId","profileSlug","createdAt","updatedAt"],"additionalProperties":false}}},"required":["profiles"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/profiles/{profileId}":{"delete":{"operationId":"detachPkiApplicationProfile","tags":["PKI Applications"],"description":"Detach a profile from an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"}},"required":["applicationId","profileId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/users":{"get":{"operationId":"listPkiApplicationUserMembers","tags":["PKI Applications"],"description":"List user members of an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","applicationId","role","createdAt","updatedAt"],"additionalProperties":false}}},"required":["memberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"addPkiApplicationUserMembers","tags":["PKI Applications"],"description":"Add user members to an application by userId, email, or username. Only users who are already members of the project can be added.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[]},"emails":{"type":"array","items":{"type":"string","format":"email"},"default":[]},"role":{"type":"string","minLength":1,"default":"operator"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","applicationId","role","createdAt","updatedAt"],"additionalProperties":false}},"skipped":{"type":"array","items":{"type":"string"}},"unresolved":{"type":"array","items":{"type":"string"}}},"required":["memberships","skipped","unresolved"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/users/{userId}":{"patch":{"operationId":"updatePkiApplicationUserMemberRole","tags":["PKI Applications"],"description":"Update the role of a user member on an application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","minLength":1}},"required":["role"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membership":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","applicationId","role","createdAt","updatedAt"],"additionalProperties":false}},"required":["membership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removePkiApplicationUserMember","tags":["PKI Applications"],"description":"Remove a user from an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"}},"required":["membershipId","applicationId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/identities":{"get":{"operationId":"listPkiApplicationIdentityMembers","tags":["PKI Applications"],"description":"List identity members of an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","applicationId","role","createdAt","updatedAt"],"additionalProperties":false}}},"required":["memberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/identities/{identityId}":{"post":{"operationId":"addPkiApplicationIdentityMember","tags":["PKI Applications"],"description":"Add an identity as a member of an application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","minLength":1}},"required":["role"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"identityId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membership":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","applicationId","role","createdAt","updatedAt"],"additionalProperties":false}},"required":["membership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePkiApplicationIdentityMemberRole","tags":["PKI Applications"],"description":"Update the role of an identity member on an application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","minLength":1}},"required":["role"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"identityId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membership":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","applicationId","role","createdAt","updatedAt"],"additionalProperties":false}},"required":["membership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removePkiApplicationIdentityMember","tags":["PKI Applications"],"description":"Remove an identity from an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"identityId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"}},"required":["membershipId","applicationId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/groups":{"get":{"operationId":"listPkiApplicationGroupMembers","tags":["PKI Applications"],"description":"List group members of an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","applicationId","role","createdAt","updatedAt"],"additionalProperties":false}}},"required":["memberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/groups/{groupId}":{"post":{"operationId":"addPkiApplicationGroupMember","tags":["PKI Applications"],"description":"Add a group as a member of an application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","minLength":1}},"required":["role"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"groupId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membership":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","applicationId","role","createdAt","updatedAt"],"additionalProperties":false}},"required":["membership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePkiApplicationGroupMemberRole","tags":["PKI Applications"],"description":"Update the role of a group member on an application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","minLength":1}},"required":["role"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"groupId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membership":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","applicationId","role","createdAt","updatedAt"],"additionalProperties":false}},"required":["membership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removePkiApplicationGroupMember","tags":["PKI Applications"],"description":"Remove a group from an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"groupId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"}},"required":["membershipId","applicationId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/profiles/{profileId}/enrollment":{"get":{"operationId":"getPkiApplicationEnrollment","tags":["PKI Applications"],"description":"Get the enrollment state for a profile on an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"},"api":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"autoRenew":{"type":"boolean"},"renewBeforeDays":{"type":"integer","nullable":true}},"required":["id","autoRenew","renewBeforeDays"],"additionalProperties":false,"nullable":true},"est":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"disableBootstrapCaValidation":{"type":"boolean"},"estEndpointUrl":{"type":"string"}},"required":["id","disableBootstrapCaValidation","estEndpointUrl"],"additionalProperties":false,"nullable":true},"acme":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"skipDnsOwnershipVerification":{"type":"boolean"},"skipEabBinding":{"type":"boolean"},"directoryUrl":{"type":"string"}},"required":["id","skipDnsOwnershipVerification","skipEabBinding","directoryUrl"],"additionalProperties":false,"nullable":true},"scep":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"challengeType":{"type":"string","enum":["static","dynamic","microsoft-intune"]},"includeCaCertInResponse":{"type":"boolean"},"allowCertBasedRenewal":{"type":"boolean"},"dynamicChallengeExpiryMinutes":{"type":"integer","nullable":true},"dynamicChallengeMaxPending":{"type":"integer","nullable":true},"scepEndpointUrl":{"type":"string"},"challengeEndpointUrl":{"type":"string","nullable":true},"raCertificatePem":{"type":"string"},"raCertExpiresAt":{"type":"string","format":"date-time"},"validationConnectionId":{"type":"string","format":"uuid","nullable":true},"signRaWithCa":{"type":"boolean"}},"required":["id","challengeType","includeCaCertInResponse","allowCertBasedRenewal","dynamicChallengeExpiryMinutes","dynamicChallengeMaxPending","scepEndpointUrl","challengeEndpointUrl","raCertificatePem","raCertExpiresAt","validationConnectionId","signRaWithCa"],"additionalProperties":false,"nullable":true},"caType":{"type":"string","enum":["internal","acme","azure-ad-cs","adcs","aws-pca","digicert","aws-acm-public-ca","venafi-tpp","godaddy"]},"estConfigured":{"type":"boolean"},"acmeConfigured":{"type":"boolean"},"scepConfigured":{"type":"boolean"}},"required":["applicationId","profileId","api","est","acme","scep","caType","estConfigured","acmeConfigured","scepConfigured"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/profiles/{profileId}/enrollment/api":{"put":{"operationId":"setPkiApplicationApiEnrollment","tags":["PKI Applications"],"description":"Enable or update the API enrollment method for a profile on an application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"autoRenew":{"type":"boolean","default":false},"renewBeforeDays":{"type":"integer","minimum":1,"maximum":365}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"},"api":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"autoRenew":{"type":"boolean"},"renewBeforeDays":{"type":"integer","nullable":true}},"required":["id","autoRenew","renewBeforeDays"],"additionalProperties":false}},"required":["applicationId","profileId","api"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"clearPkiApplicationApiEnrollment","tags":["PKI Applications"],"description":"Disable the API enrollment method for a profile on an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"}},"required":["applicationId","profileId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/profiles/{profileId}/enrollment/est":{"put":{"operationId":"setPkiApplicationEstEnrollment","tags":["PKI Applications"],"description":"Enable or update the EST enrollment method for a profile on an application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"passphrase":{"type":"string","minLength":8},"disableBootstrapCaValidation":{"type":"boolean","default":false},"caChain":{"type":"string"}},"required":["passphrase"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"},"est":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"disableBootstrapCaValidation":{"type":"boolean"}},"required":["id","disableBootstrapCaValidation"],"additionalProperties":false}},"required":["applicationId","profileId","est"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"clearPkiApplicationEstEnrollment","tags":["PKI Applications"],"description":"Disable the EST enrollment method for a profile on an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"}},"required":["applicationId","profileId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/profiles/{profileId}/enrollment/acme":{"put":{"operationId":"setPkiApplicationAcmeEnrollment","tags":["PKI Applications"],"description":"Enable or update the ACME enrollment method for a profile on an application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"skipDnsOwnershipVerification":{"type":"boolean","default":false},"skipEabBinding":{"type":"boolean","default":false}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"},"acme":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"skipDnsOwnershipVerification":{"type":"boolean"},"skipEabBinding":{"type":"boolean"}},"required":["id","skipDnsOwnershipVerification","skipEabBinding"],"additionalProperties":false}},"required":["applicationId","profileId","acme"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"clearPkiApplicationAcmeEnrollment","tags":["PKI Applications"],"description":"Disable the ACME enrollment method for a profile on an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"}},"required":["applicationId","profileId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/profiles/{profileId}/enrollment/acme/eab/reveal":{"post":{"operationId":"revealPkiApplicationAcmeEabSecret","tags":["PKI Applications"],"description":"Reveal the ACME EAB secret for a profile on an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"},"eabKid":{"type":"string"},"eabSecret":{"type":"string"}},"required":["applicationId","profileId","eabKid","eabSecret"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/profiles/{profileId}/enrollment/acme/eab/rotate":{"post":{"operationId":"rotatePkiApplicationAcmeEabSecret","tags":["PKI Applications"],"description":"Rotate the ACME EAB secret for a profile on an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"}},"required":["applicationId","profileId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/profiles/{profileId}/enrollment/scep":{"put":{"operationId":"setPkiApplicationScepEnrollment","tags":["PKI Applications"],"description":"Enable or update the SCEP enrollment method for a profile on an application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"challengeType":{"type":"string","enum":["static","dynamic","microsoft-intune"]},"challengePassword":{"type":"string"},"includeCaCertInResponse":{"type":"boolean","default":true},"allowCertBasedRenewal":{"type":"boolean"},"dynamicChallengeExpiryMinutes":{"type":"integer","minimum":5,"maximum":1440},"dynamicChallengeMaxPending":{"type":"integer","minimum":1,"maximum":1000},"validationConnectionId":{"type":"string","format":"uuid"},"signRaWithCa":{"type":"boolean"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"},"scep":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"challengeType":{"type":"string","enum":["static","dynamic","microsoft-intune"]}},"required":["id","challengeType"],"additionalProperties":false}},"required":["applicationId","profileId","scep"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"clearPkiApplicationScepEnrollment","tags":["PKI Applications"],"description":"Disable the SCEP enrollment method for a profile on an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"profileId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"applicationId":{"type":"string","format":"uuid"},"profileId":{"type":"string","format":"uuid"}},"required":["applicationId","profileId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/alerts":{"get":{"operationId":"listPkiApplicationAlerts","tags":["PKI Applications"],"description":"Deprecated: application alerts are managed with the alerts API (/api/v1/alerts). List legacy alerts for an application.","parameters":[{"schema":{"type":"string"},"in":"query","name":"search","required":false},{"schema":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"in":"query","name":"eventType","required":false},{"schema":{"type":"boolean"},"in":"query","name":"enabled","required":false},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"alerts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"eventType":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"alertBefore":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"enabled":{"type":"boolean"},"applicationId":{"type":"string","format":"uuid","nullable":true},"notificationConfig":{"type":"object","properties":{"enableDailyNotification":{"type":"boolean","default":false}},"additionalProperties":false,"nullable":true},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"channelType":{"type":"string","enum":["email","webhook","slack","pagerduty"]},"config":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","channelType","config","enabled","createdAt","updatedAt"],"additionalProperties":false}},"lastRun":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["success","failed"]},"error":{"type":"string","nullable":true}},"required":["timestamp","status","error"],"additionalProperties":false,"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","description","eventType","filters","enabled","notificationConfig","channels","lastRun","createdAt","updatedAt"],"additionalProperties":false}},"total":{"type":"integer","minimum":0}},"required":["alerts","total"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPkiApplicationAlert","tags":["PKI Applications"],"description":"Deprecated: legacy application alerts can no longer be created. Use the alerts API (/api/v1/alerts) instead.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"description":{"type":"string","maxLength":1000},"eventType":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"alertBefore":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"enabled":{"type":"boolean","default":true},"notificationConfig":{"type":"object","properties":{"enableDailyNotification":{"type":"boolean","default":false}},"additionalProperties":false,"nullable":true},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"channelType":{"type":"string","enum":["email","webhook","slack","pagerduty"]},"config":{"anyOf":[{"type":"object","properties":{"recipients":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"maxItems":10}},"required":["recipients"],"additionalProperties":false},{"type":"object","properties":{"url":{"type":"string","format":"uri"},"signingSecret":{"type":"string","maxLength":256,"nullable":true}},"required":["url"],"additionalProperties":false},{"type":"object","properties":{"webhookUrl":{"type":"string","format":"uri"}},"required":["webhookUrl"],"additionalProperties":false},{"type":"object","properties":{"integrationKey":{"type":"string"}},"required":["integrationKey"],"additionalProperties":false}]},"enabled":{"type":"boolean","default":true}},"required":["channelType","config"],"additionalProperties":false},"minItems":1,"maxItems":10}},"required":["name","eventType","filters","channels"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"alert":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"eventType":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"alertBefore":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"enabled":{"type":"boolean"},"applicationId":{"type":"string","format":"uuid","nullable":true},"notificationConfig":{"type":"object","properties":{"enableDailyNotification":{"type":"boolean","default":false}},"additionalProperties":false,"nullable":true},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"channelType":{"type":"string","enum":["email","webhook","slack","pagerduty"]},"config":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","channelType","config","enabled","createdAt","updatedAt"],"additionalProperties":false}},"lastRun":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["success","failed"]},"error":{"type":"string","nullable":true}},"required":["timestamp","status","error"],"additionalProperties":false,"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","description","eventType","filters","enabled","notificationConfig","channels","lastRun","createdAt","updatedAt"],"additionalProperties":false}},"required":["alert"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/applications/{applicationId}/alerts/{alertId}":{"patch":{"operationId":"updatePkiApplicationAlert","tags":["PKI Applications"],"description":"Deprecated: legacy application alerts can no longer be edited. Use the alerts API (/api/v1/alerts) instead.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"description":{"type":"string","maxLength":1000},"eventType":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"alertBefore":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"enabled":{"type":"boolean","default":true},"notificationConfig":{"type":"object","properties":{"enableDailyNotification":{"type":"boolean","default":false}},"additionalProperties":false,"nullable":true},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"channelType":{"type":"string","enum":["email","webhook","slack","pagerduty"]},"config":{"anyOf":[{"type":"object","properties":{"recipients":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"maxItems":10}},"required":["recipients"],"additionalProperties":false},{"type":"object","properties":{"url":{"type":"string","format":"uri"},"signingSecret":{"type":"string","maxLength":256,"nullable":true}},"required":["url"],"additionalProperties":false},{"type":"object","properties":{"webhookUrl":{"type":"string","format":"uri"}},"required":["webhookUrl"],"additionalProperties":false},{"type":"object","properties":{"integrationKey":{"type":"string"}},"required":["integrationKey"],"additionalProperties":false}]},"enabled":{"type":"boolean","default":true}},"required":["channelType","config"],"additionalProperties":false},"minItems":1,"maxItems":10}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"alertId","required":true}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"alert":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"eventType":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"alertBefore":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"enabled":{"type":"boolean"},"applicationId":{"type":"string","format":"uuid","nullable":true},"notificationConfig":{"type":"object","properties":{"enableDailyNotification":{"type":"boolean","default":false}},"additionalProperties":false,"nullable":true},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"channelType":{"type":"string","enum":["email","webhook","slack","pagerduty"]},"config":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","channelType","config","enabled","createdAt","updatedAt"],"additionalProperties":false}},"lastRun":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["success","failed"]},"error":{"type":"string","nullable":true}},"required":["timestamp","status","error"],"additionalProperties":false,"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","description","eventType","filters","enabled","notificationConfig","channels","lastRun","createdAt","updatedAt"],"additionalProperties":false}},"required":["alert"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deletePkiApplicationAlert","tags":["PKI Applications"],"description":"Deprecated: application alerts are managed with the alerts API (/api/v1/alerts). Delete a legacy alert from an application.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"applicationId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"alertId","required":true}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"alert":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"eventType":{"type":"string","enum":["expiration","renewal","issuance","revocation"]},"alertBefore":{"type":"string"},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","enum":["profile_name","common_name","san","include_cas"]},"operator":{"type":"string","enum":["equals","matches","contains","starts_with","ends_with"]},"value":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}},{"type":"boolean"}]}},"required":["field","operator","value"],"additionalProperties":false}},"enabled":{"type":"boolean"},"applicationId":{"type":"string","format":"uuid","nullable":true},"notificationConfig":{"type":"object","properties":{"enableDailyNotification":{"type":"boolean","default":false}},"additionalProperties":false,"nullable":true},"channels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"channelType":{"type":"string","enum":["email","webhook","slack","pagerduty"]},"config":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","channelType","config","enabled","createdAt","updatedAt"],"additionalProperties":false}},"lastRun":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"status":{"type":"string","enum":["success","failed"]},"error":{"type":"string","nullable":true}},"required":["timestamp","status","error"],"additionalProperties":false,"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","name","description","eventType","filters","enabled","notificationConfig","channels","lastRun","createdAt","updatedAt"],"additionalProperties":false}},"required":["alert"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers":{"post":{"operationId":"createSigner","tags":["PKI Signers"],"description":"Create a code signing signer","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"description":{"type":"string","maxLength":256},"caId":{"type":"string","format":"uuid"},"commonName":{"type":"string","minLength":1,"maxLength":256},"certificateTtlDays":{"type":"integer","minimum":1,"maximum":3650},"certificateRenewBeforeDays":{"type":"integer","minimum":1,"maximum":30,"nullable":true},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1"]},"certificateId":{"type":"string","format":"uuid"},"certificate":{"type":"object","properties":{"keySource":{"type":"string","enum":["infisical","hsm"],"default":"infisical"},"hsmConnectorId":{"type":"string","format":"uuid"}},"additionalProperties":false},"externalConfiguration":{"anyOf":[{"type":"object","properties":{"caType":{"type":"string","enum":["digicert"]},"reissueFromExternalOrderId":{"type":"string","minLength":1,"description":"Reissue into this existing DigiCert order instead of placing a new order (reuses the subscription slot)."}},"required":["caType"],"additionalProperties":false},{"type":"object","properties":{"caType":{"type":"string","enum":["adcs"]},"template":{"type":"string","minLength":1,"description":"The AD CS certificate template this signer requests when issuing (e.g. a code-signing template)."}},"required":["caType"],"additionalProperties":false}]},"approvalPolicyId":{"type":"string","format":"uuid"},"members":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["user","identity","group"]},"id":{"type":"string","format":"uuid"},"role":{"type":"string","minLength":1}},"required":["kind","id","role"],"additionalProperties":false}},"approvalPolicy":{"type":"object","properties":{"steps":{"type":"array","items":{"type":"object","properties":{"stepNumber":{"type":"integer","minimum":1},"name":{"type":"string","maxLength":64,"nullable":true},"requiredApprovals":{"type":"integer","minimum":1},"approverUserIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[]},"approverGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[]}},"required":["stepNumber","requiredApprovals"],"additionalProperties":false}},"constraints":{"type":"object","properties":{"maxSignings":{"type":"integer","minimum":1,"nullable":true},"maxWindowDuration":{"type":"string","nullable":true}},"additionalProperties":false}},"required":["steps"],"additionalProperties":false}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"status":{"type":"string","default":"active"},"certificateId":{"type":"string","format":"uuid","nullable":true},"approvalPolicyId":{"type":"string","format":"uuid","nullable":true},"lastSignedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"commonName":{"type":"string","nullable":true},"certificateTtlDays":{"type":"number","nullable":true},"certificateRenewBeforeDays":{"type":"number","nullable":true},"certificateFailureReason":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","default":"RSA_2048"},"externalCaConfig":{"nullable":true}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listSigners","tags":["PKI Signers"],"description":"List code signing signers for a project","parameters":[{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"string"},"in":"query","name":"search","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"signers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"status":{"type":"string","default":"active"},"certificateId":{"type":"string","format":"uuid","nullable":true},"approvalPolicyId":{"type":"string","format":"uuid","nullable":true},"lastSignedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"commonName":{"type":"string","nullable":true},"certificateTtlDays":{"type":"number","nullable":true},"certificateRenewBeforeDays":{"type":"number","nullable":true},"certificateFailureReason":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","default":"RSA_2048"},"externalCaConfig":{"nullable":true},"certificateCommonName":{"type":"string","nullable":true},"certificateSerialNumber":{"type":"string","nullable":true},"certificateNotAfter":{"type":"string","format":"date-time","nullable":true},"approvalPolicyName":{"type":"string","nullable":true}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["signers","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}":{"get":{"operationId":"getSignerById","tags":["PKI Signers"],"description":"Get a code signing signer by ID","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"status":{"type":"string","default":"active"},"certificateId":{"type":"string","format":"uuid","nullable":true},"approvalPolicyId":{"type":"string","format":"uuid","nullable":true},"lastSignedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"commonName":{"type":"string","nullable":true},"certificateTtlDays":{"type":"number","nullable":true},"certificateRenewBeforeDays":{"type":"number","nullable":true},"certificateFailureReason":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","default":"RSA_2048"},"externalCaConfig":{"nullable":true},"certificateCommonName":{"type":"string","nullable":true},"certificateSerialNumber":{"type":"string","nullable":true},"certificateNotAfter":{"type":"string","format":"date-time","nullable":true},"certificateNotBefore":{"type":"string","format":"date-time","nullable":true},"certificateKeyAlgorithm":{"type":"string","nullable":true},"certificateKeySource":{"type":"string","nullable":true},"certificateHsmConnectorId":{"type":"string","nullable":true},"certificateStatus":{"type":"string","nullable":true},"certificateCaId":{"type":"string","nullable":true},"approvalPolicyName":{"type":"string","nullable":true},"externalOrder":{"type":"object","properties":{"provider":{"type":"string"},"orderId":{"type":"number"},"status":{"type":"string","nullable":true}},"required":["provider","orderId","status"],"additionalProperties":false,"nullable":true}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateSigner","tags":["PKI Signers"],"description":"Update a code signing signer","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"description":{"type":"string","maxLength":256,"nullable":true},"certificateRenewBeforeDays":{"type":"integer","minimum":1,"maximum":30,"nullable":true}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"status":{"type":"string","default":"active"},"certificateId":{"type":"string","format":"uuid","nullable":true},"approvalPolicyId":{"type":"string","format":"uuid","nullable":true},"lastSignedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"commonName":{"type":"string","nullable":true},"certificateTtlDays":{"type":"number","nullable":true},"certificateRenewBeforeDays":{"type":"number","nullable":true},"certificateFailureReason":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","default":"RSA_2048"},"externalCaConfig":{"nullable":true}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteSigner","tags":["PKI Signers"],"description":"Delete a code signing signer","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"status":{"type":"string","default":"active"},"certificateId":{"type":"string","format":"uuid","nullable":true},"approvalPolicyId":{"type":"string","format":"uuid","nullable":true},"lastSignedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"commonName":{"type":"string","nullable":true},"certificateTtlDays":{"type":"number","nullable":true},"certificateRenewBeforeDays":{"type":"number","nullable":true},"certificateFailureReason":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","default":"RSA_2048"},"externalCaConfig":{"nullable":true}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/permissions":{"get":{"operationId":"getSignerPermissions","tags":["PKI Signers"],"description":"Get the actor's effective resource permissions on this signer.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"permissions":{"type":"array"},"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"actorUserId":{"type":"string","nullable":true},"actorIdentityId":{"type":"string","nullable":true},"actorGroupId":{"type":"string","nullable":true},"roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"customRoleSlug":{"type":"string","nullable":true}},"required":["role"],"additionalProperties":false}}},"required":["id","roles"],"additionalProperties":false}}},"required":["permissions","memberships"],"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/issuance/check":{"post":{"operationId":"checkSignerIssuance","tags":["PKI Signers"],"description":"Poll the upstream CA for a pending signer's certificate immediately instead of waiting for the next scheduled check.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"status":{"type":"string","default":"active"},"certificateId":{"type":"string","format":"uuid","nullable":true},"approvalPolicyId":{"type":"string","format":"uuid","nullable":true},"lastSignedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"commonName":{"type":"string","nullable":true},"certificateTtlDays":{"type":"number","nullable":true},"certificateRenewBeforeDays":{"type":"number","nullable":true},"certificateFailureReason":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","default":"RSA_2048"},"externalCaConfig":{"nullable":true},"certificateCommonName":{"type":"string","nullable":true},"certificateSerialNumber":{"type":"string","nullable":true},"certificateNotAfter":{"type":"string","format":"date-time","nullable":true},"certificateNotBefore":{"type":"string","format":"date-time","nullable":true},"certificateKeyAlgorithm":{"type":"string","nullable":true},"certificateKeySource":{"type":"string","nullable":true},"certificateHsmConnectorId":{"type":"string","nullable":true},"certificateStatus":{"type":"string","nullable":true},"certificateCaId":{"type":"string","nullable":true},"approvalPolicyName":{"type":"string","nullable":true},"externalOrder":{"type":"object","properties":{"provider":{"type":"string"},"orderId":{"type":"number"},"status":{"type":"string","nullable":true}},"required":["provider","orderId","status"],"additionalProperties":false,"nullable":true}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/status":{"patch":{"operationId":"updateSignerStatus","tags":["PKI Signers"],"description":"Enable or disable a signer in a single endpoint","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["active","disabled"]}},"required":["status"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"status":{"type":"string","default":"active"},"certificateId":{"type":"string","format":"uuid","nullable":true},"approvalPolicyId":{"type":"string","format":"uuid","nullable":true},"lastSignedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"commonName":{"type":"string","nullable":true},"certificateTtlDays":{"type":"number","nullable":true},"certificateRenewBeforeDays":{"type":"number","nullable":true},"certificateFailureReason":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","default":"RSA_2048"},"externalCaConfig":{"nullable":true}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/sign":{"post":{"operationId":"signData","tags":["PKI Signers"],"description":"Sign a pre-hashed digest with a code signing signer","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"string","minLength":1,"maxLength":172},"signingAlgorithm":{"type":"string","enum":["RSASSA_PSS_SHA_512","RSASSA_PSS_SHA_384","RSASSA_PSS_SHA_256","RSASSA_PKCS1_V1_5_SHA_512","RSASSA_PKCS1_V1_5_SHA_384","RSASSA_PKCS1_V1_5_SHA_256","ECDSA_SHA_512","ECDSA_SHA_384","ECDSA_SHA_256","ED25519","ML_DSA_44","ML_DSA_65","ML_DSA_87"]},"isDigest":{"type":"boolean","default":false},"clientMetadata":{"type":"object","properties":{"tool":{"type":"string","maxLength":128,"description":"The signing application. Compared against a 'signingApplication' scope on the approval."},"signingApplication":{"type":"string","maxLength":128,"description":"Alias of 'tool', matching the name this parameter has in an approval's scope."},"hostname":{"type":"string","maxLength":256,"description":"The machine the sign call is made from."},"command":{"type":"string","maxLength":32767,"description":"The command line that issued the sign call."},"osUsername":{"type":"string","maxLength":256,"description":"The operating system account running the signing tool."},"signingApplicationHash":{"type":"string","maxLength":64,"description":"SHA-256 checksum of the signing application binary."}},"additionalProperties":false,"description":"Context describing the signing situation. Values here are compared against any scope declared on the approval, and are recorded on the signing operation for audit."}},"required":["data","signingAlgorithm"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"signature":{"type":"string"},"signingAlgorithm":{"type":"string"},"signerId":{"type":"string"}},"required":["signature","signingAlgorithm","signerId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/public-key":{"get":{"operationId":"getSignerPublicKey","tags":["PKI Signers"],"description":"Get the public key for a code signing signer","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"publicKey":{"type":"string"},"algorithm":{"type":"string"}},"required":["publicKey","algorithm"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/certificate/reissue":{"post":{"operationId":"reissueSignerCertificate","tags":["PKI Signers"],"description":"Re-issue the signer's certificate (optionally from a different CA or with a different key source)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caId":{"type":"string","format":"uuid"},"commonName":{"type":"string","minLength":1,"maxLength":256},"certificateTtlDays":{"type":"integer","minimum":1,"maximum":3650},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1"]},"certificate":{"type":"object","properties":{"keySource":{"type":"string","enum":["infisical","hsm"]},"hsmConnectorId":{"type":"string","format":"uuid"}},"required":["keySource"],"additionalProperties":false},"externalConfiguration":{"anyOf":[{"type":"object","properties":{"caType":{"type":"string","enum":["digicert"]},"reissueFromExternalOrderId":{"type":"string","minLength":1,"description":"Reissue into this existing DigiCert order instead of placing a new order (reuses the subscription slot)."}},"required":["caType"],"additionalProperties":false},{"type":"object","properties":{"caType":{"type":"string","enum":["adcs"]},"template":{"type":"string","minLength":1,"description":"The AD CS certificate template this signer requests when issuing (e.g. a code-signing template)."}},"required":["caType"],"additionalProperties":false}]}},"required":["caId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"status":{"type":"string","default":"active"},"certificateId":{"type":"string","format":"uuid","nullable":true},"approvalPolicyId":{"type":"string","format":"uuid","nullable":true},"lastSignedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"commonName":{"type":"string","nullable":true},"certificateTtlDays":{"type":"number","nullable":true},"certificateRenewBeforeDays":{"type":"number","nullable":true},"certificateFailureReason":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","default":"RSA_2048"},"externalCaConfig":{"nullable":true}},"required":["id","name","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/certificate":{"get":{"operationId":"exportSignerCertificate","tags":["PKI Signers"],"description":"Export the signer's leaf certificate as PEM","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificatePem":{"type":"string"},"serialNumber":{"type":"string"},"signerName":{"type":"string"}},"required":["certificatePem","serialNumber","signerName"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/approval-policy":{"get":{"operationId":"getSignerApprovalPolicy","tags":["PKI Signers"],"description":"Read the signer's approval policy (steps, approvers, limits)","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"},"hasSteps":{"type":"boolean"},"steps":{"type":"array"},"constraints":{"type":"object","properties":{"maxSignings":{"type":"number","nullable":true},"maxWindowDuration":{"type":"string","nullable":true}},"required":["maxSignings","maxWindowDuration"],"additionalProperties":false}},"required":["id","signerId","hasSteps","steps","constraints"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"put":{"operationId":"updateSignerApprovalPolicy","tags":["PKI Signers"],"description":"Replace the signer's approval policy (steps, approvers, limits)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"steps":{"type":"array","items":{"type":"object","properties":{"stepNumber":{"type":"integer","minimum":1},"name":{"type":"string","maxLength":64,"nullable":true},"requiredApprovals":{"type":"integer","minimum":1},"approverUserIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[]},"approverGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[]}},"required":["stepNumber","requiredApprovals"],"additionalProperties":false}},"constraints":{"type":"object","properties":{"maxSignings":{"type":"integer","minimum":1,"nullable":true},"maxWindowDuration":{"type":"string","nullable":true}},"additionalProperties":false}},"required":["steps"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/v1/cert-manager/signers/{signerId}/requests":{"get":{"operationId":"listSignerRequests","tags":["PKI Signers"],"description":"List signing approval requests for a signer","parameters":[{"schema":{"type":"string"},"in":"query","name":"statuses","required":false},{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"in":"query","name":"limit","required":false},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"operationId":"requestToSign","tags":["PKI Signers"],"description":"Open a request to sign with this signer (operator self-serve)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"justification":{"type":"string","minLength":1,"maxLength":2048},"requestedSignings":{"type":"integer","minimum":1},"requestedWindowDuration":{"type":"string","description":"How long the approval stays usable once it is granted, for example '4h'. The window starts when the request is approved."},"scope":{"type":"object","properties":{"command":{"type":"string","maxLength":32767},"signingApplication":{"type":"string","maxLength":256},"signingApplicationHash":{"type":"string","maxLength":64},"hostname":{"type":"string","maxLength":256},"osUsername":{"type":"string","maxLength":256},"ipAddress":{"type":"string","maxLength":45,"nullable":true},"dataHash":{"type":"string","maxLength":64}},"additionalProperties":false,"description":"Optional parameters to scope this approval to (command, signingApplication, signingApplicationHash, hostname, osUsername, ipAddress, dataHash). Every value declared here must match at signing time or the sign call is denied; parameters left out are not restricted. A command must match exactly, apart from whitespace, so a different order of options is a different command. ipAddress is compared against the address the sign call arrives from and dataHash against the digest of the submitted payload, so those two hold even if a caller reports something else. A machine identity that declares a scope without naming ipAddress has it filled in with the address the request arrives from; send null to leave signing unrestricted by address."}},"required":["justification"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/v1/cert-manager/signers/{signerId}/requests/pre-approve":{"post":{"operationId":"preApproveSigning","tags":["PKI Signers"],"description":"Pre-approve signing for a member (admin only)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"granteeUserId":{"type":"string","format":"uuid"},"granteeIdentityId":{"type":"string","format":"uuid"},"justification":{"type":"string","minLength":1,"maxLength":2048},"requestedSignings":{"type":"integer","minimum":1},"requestedWindowDuration":{"type":"string","description":"How long the approval stays usable once it is granted, for example '4h'. The window starts when the request is approved."},"scope":{"type":"object","properties":{"command":{"type":"string","maxLength":32767},"signingApplication":{"type":"string","maxLength":256},"signingApplicationHash":{"type":"string","maxLength":64},"hostname":{"type":"string","maxLength":256},"osUsername":{"type":"string","maxLength":256},"ipAddress":{"type":"string","maxLength":45},"dataHash":{"type":"string","maxLength":64}},"additionalProperties":false,"description":"Optional parameters to scope this approval to (command, signingApplication, signingApplicationHash, hostname, osUsername, ipAddress, dataHash). Every value declared here must match at signing time or the sign call is denied; parameters left out are not restricted. A command must match exactly, apart from whitespace, so a different order of options is a different command. ipAddress is compared against the address the sign call arrives from and dataHash against the digest of the submitted payload, so those two hold even if a caller reports something else. A machine identity that declares a scope without naming ipAddress has it filled in with the address the request arrives from; send null to leave signing unrestricted by address."}},"required":["justification"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/v1/cert-manager/signers/{signerId}/requests/{requestId}/revoke":{"post":{"operationId":"revokeSignerRequest","tags":["PKI Signers"],"description":"Revoke a pending or active signing request","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"requestId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/v1/cert-manager/signers/{signerId}/operations":{"get":{"operationId":"listSigningOperations","tags":["PKI Signers"],"description":"List signing operations for a signer","parameters":[{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"string","enum":["pending","success","failed","denied"]},"in":"query","name":"status","required":false},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"operations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"},"status":{"type":"string"},"signingAlgorithm":{"type":"string"},"dataHash":{"type":"string"},"actorType":{"type":"string"},"actorId":{"type":"string","format":"uuid"},"actorName":{"type":"string","nullable":true},"approvalGrantId":{"type":"string","format":"uuid","nullable":true},"clientMetadata":{"nullable":true},"errorMessage":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"actorMembershipId":{"type":"string","format":"uuid","nullable":true}},"required":["id","signerId","status","signingAlgorithm","dataHash","actorType","actorId","actorName","createdAt","actorMembershipId"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["operations","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/operations/{operationId}":{"get":{"operationId":"getSigningOperation","tags":["PKI Signers"],"description":"Get a signing operation with its full client context","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"operationId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"operation":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"},"status":{"type":"string"},"signingAlgorithm":{"type":"string"},"dataHash":{"type":"string"},"actorType":{"type":"string"},"actorId":{"type":"string","format":"uuid"},"actorName":{"type":"string","nullable":true},"approvalGrantId":{"type":"string","format":"uuid","nullable":true},"clientMetadata":{"nullable":true},"errorMessage":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"actorMembershipId":{"type":"string","format":"uuid","nullable":true}},"required":["id","signerId","status","signingAlgorithm","dataHash","actorType","actorId","actorName","createdAt","actorMembershipId"],"additionalProperties":false},"signerName":{"type":"string"}},"required":["operation","signerName"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/users":{"get":{"operationId":"listSignerUserMembers","tags":["PKI Signers"],"description":"List user members of a signer","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","signerId","role","createdAt","updatedAt"],"additionalProperties":false}}},"required":["memberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"addSignerUserMembers","tags":["PKI Signers"],"description":"Add user members to a signer","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"userIds":{"type":"array","items":{"type":"string","format":"uuid"},"default":[]},"emails":{"type":"array","items":{"type":"string","format":"email"},"default":[]},"role":{"type":"string","enum":["admin","operator","auditor"],"default":"operator"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","signerId","role","createdAt","updatedAt"],"additionalProperties":false}},"skipped":{"type":"array","items":{"type":"string"}},"unresolved":{"type":"array","items":{"type":"string"}}},"required":["memberships","skipped","unresolved"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/users/{userId}":{"patch":{"operationId":"updateSignerUserRole","tags":["PKI Signers"],"description":"Update a user member's role on a signer","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","enum":["admin","operator","auditor"]}},"required":["role"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membership":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","signerId","role","createdAt","updatedAt"],"additionalProperties":false}},"required":["membership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removeSignerUserMember","tags":["PKI Signers"],"description":"Remove a user from a signer","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"}},"required":["membershipId","signerId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/effective-users":{"get":{"operationId":"listSignerEffectiveUserMembers","tags":["PKI Signers"],"description":"List users that can act on this signer either through a direct membership or through a group that's a signer member.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"viaGroupIds":{"type":"array","items":{"type":"string","format":"uuid"}},"isDirect":{"type":"boolean"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["actorUserId","actorIdentityId","role","viaGroupIds","isDirect","details"],"additionalProperties":false}}},"required":["members"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/identities":{"get":{"operationId":"listSignerIdentityMembers","tags":["PKI Signers"],"description":"List machine identity members of a signer","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","signerId","role","createdAt","updatedAt"],"additionalProperties":false}}},"required":["memberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"addSignerIdentityMember","tags":["PKI Signers"],"description":"Add a machine identity to a signer","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"identityId":{"type":"string","format":"uuid"},"role":{"type":"string","enum":["admin","operator","auditor"],"default":"operator"}},"required":["identityId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","signerId","role","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/identities/{identityId}":{"patch":{"operationId":"updateSignerIdentityRole","tags":["PKI Signers"],"description":"Update a machine identity's role on a signer","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","enum":["admin","operator","auditor"]}},"required":["role"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"identityId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membership":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","signerId","role","createdAt","updatedAt"],"additionalProperties":false}},"required":["membership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removeSignerIdentityMember","tags":["PKI Signers"],"description":"Remove a machine identity from a signer","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"identityId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"}},"required":["membershipId","signerId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/effective-identities":{"get":{"operationId":"listSignerEffectiveIdentityMembers","tags":["PKI Signers"],"description":"List machine identities that can act on this signer either directly or via a group that's a signer member.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"members":{"type":"array","items":{"type":"object","properties":{"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"viaGroupIds":{"type":"array","items":{"type":"string","format":"uuid"}},"isDirect":{"type":"boolean"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["actorUserId","actorIdentityId","role","viaGroupIds","isDirect","details"],"additionalProperties":false}}},"required":["members"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/groups":{"get":{"operationId":"listSignerGroupMembers","tags":["PKI Signers"],"description":"List group members of a signer","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","signerId","role","createdAt","updatedAt"],"additionalProperties":false}}},"required":["memberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"addSignerGroupMember","tags":["PKI Signers"],"description":"Add a group to a signer","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"groupId":{"type":"string","format":"uuid"},"role":{"type":"string","enum":["admin","operator","auditor"],"default":"operator"}},"required":["groupId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","signerId","role","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/signers/{signerId}/groups/{groupId}":{"patch":{"operationId":"updateSignerGroupRole","tags":["PKI Signers"],"description":"Update a group's role on a signer","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"type":"string","enum":["admin","operator","auditor"]}},"required":["role"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"groupId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membership":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"},"actorUserId":{"type":"string","format":"uuid","nullable":true},"actorIdentityId":{"type":"string","format":"uuid","nullable":true},"actorGroupId":{"type":"string","format":"uuid","nullable":true},"role":{"type":"string"},"customRoleId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"details":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"authMethod":{"type":"string","nullable":true},"slug":{"type":"string","nullable":true}},"required":["name"],"additionalProperties":false,"nullable":true}},"required":["membershipId","signerId","role","createdAt","updatedAt"],"additionalProperties":false}},"required":["membership"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removeSignerGroupMember","tags":["PKI Signers"],"description":"Remove a group from a signer","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"signerId","required":true},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"groupId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"membershipId":{"type":"string","format":"uuid"},"signerId":{"type":"string","format":"uuid"}},"required":["membershipId","signerId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/certificate-cleanup":{"get":{"operationId":"getCertificateCleanupConfig","tags":["PKI Certificates"],"description":"Get certificate cleanup configuration for a project","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"config":{"type":"object","properties":{"isEnabled":{"type":"boolean","default":false},"postExpiryRetentionDays":{"type":"number","default":3},"skipCertsWithActiveSyncs":{"type":"boolean","default":true},"lastRunStatus":{"type":"string","nullable":true},"lastRunAt":{"type":"string","format":"date-time","nullable":true},"lastRunCertsDeleted":{"type":"number","default":0},"lastRunMessage":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["createdAt","updatedAt"],"additionalProperties":false,"nullable":true}},"required":["config"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"put":{"operationId":"updateCertificateCleanupConfig","tags":["PKI Certificates"],"description":"Create or update certificate cleanup configuration for a project","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"Enable cleanup"},"postExpiryRetentionDays":{"type":"integer","minimum":1,"maximum":30,"description":"Days after expiration before deletion"},"skipCertsWithActiveSyncs":{"type":"boolean","description":"Skip certificates with active syncs"}},"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"config":{"type":"object","properties":{"isEnabled":{"type":"boolean","default":false},"postExpiryRetentionDays":{"type":"number","default":3},"skipCertsWithActiveSyncs":{"type":"boolean","default":true},"lastRunStatus":{"type":"string","nullable":true},"lastRunAt":{"type":"string","format":"date-time","nullable":true},"lastRunCertsDeleted":{"type":"number","default":0},"lastRunMessage":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["createdAt","updatedAt"],"additionalProperties":false}},"required":["config"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/access/users":{"get":{"operationId":"listCertManagerUsers","tags":["Project Users"],"description":"List Certificate Manager users.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"userId":{"type":"string","format":"uuid"},"user":{"type":"object","properties":{"username":{"type":"string"},"email":{"type":"string","nullable":true},"isEmailVerified":{"type":"boolean","default":false,"nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"authMethods":{"type":"array","items":{"type":"string"},"nullable":true},"id":{"type":"string","format":"uuid"},"publicKey":{"type":"string","nullable":true}},"required":["username","id"],"additionalProperties":false},"roles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string"},"customRoleId":{"type":"string","nullable":true},"customRoleName":{"type":"string","nullable":true},"customRoleSlug":{"type":"string","nullable":true},"isTemporary":{"type":"boolean"},"temporaryMode":{"type":"string","nullable":true},"temporaryRange":{"type":"string","nullable":true},"temporaryAccessStartTime":{"type":"string","format":"date-time","nullable":true},"temporaryAccessEndTime":{"type":"string","format":"date-time","nullable":true}},"required":["id","role","isTemporary"],"additionalProperties":false}}},"required":["id","createdAt","userId","user","roles"],"additionalProperties":false}}},"required":["memberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"inviteCertManagerUsers","tags":["Project Users"],"description":"Invite users to Certificate Manager.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"default":[]},"usernames":{"type":"array","items":{"type":"string"},"default":[]},"roleSlugs":{"type":"array","items":{"type":"string"},"minItems":1}},"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"memberships":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"userId":{"type":"string","format":"uuid"}},"required":["id","createdAt","updatedAt","userId"],"additionalProperties":false}}},"required":["memberships"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/options":{"get":{"operationId":"listPkiSyncOptions","tags":["PKI Syncs"],"description":"List the available PKI Sync Options.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncOptions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"connection":{"type":"string","enum":["github","github-radar","aws","databricks","gcp","azure-key-vault","azure-app-configuration","azure-client-secrets","azure-devops","azure-adcs","adcs","azure-dns","humanitec","terraform-cloud","vercel","postgres","mssql","mysql","camunda","windmill","auth0","hashicorp-vault","ldap","teamcity","oci","oracledb","1password","heroku","render","flyio","trigger-dev","gitlab","cloudflare","dns-made-easy","ultradns","zabbix","railway","bitbucket","checkly","supabase","digital-ocean","netlify","okta","redis","mongodb","laravel-forge","chef","northflank","octopus-deploy","ssh","dbt","smb","winrm","open-router","openai","circleci","azure-entra-id","venafi","venafi-tpp","external-infisical","doppler","netscaler","anthropic","ovh","devin","ona","digicert","travis-ci","salesforce","snowflake","datadog","f5-big-ip","godaddy","convex","rundeck","hasura-cloud","qovery","cloud-66","litellm","fireworks","kemp-loadmaster","microsoft-intune","nutanix-prism-central","powerdns","spacelift","daytona","stripe","hpe-ilo"]},"additionalConnections":{"type":"array","items":{"type":"string","enum":["github","github-radar","aws","databricks","gcp","azure-key-vault","azure-app-configuration","azure-client-secrets","azure-devops","azure-adcs","adcs","azure-dns","humanitec","terraform-cloud","vercel","postgres","mssql","mysql","camunda","windmill","auth0","hashicorp-vault","ldap","teamcity","oci","oracledb","1password","heroku","render","flyio","trigger-dev","gitlab","cloudflare","dns-made-easy","ultradns","zabbix","railway","bitbucket","checkly","supabase","digital-ocean","netlify","okta","redis","mongodb","laravel-forge","chef","northflank","octopus-deploy","ssh","dbt","smb","winrm","open-router","openai","circleci","azure-entra-id","venafi","venafi-tpp","external-infisical","doppler","netscaler","anthropic","ovh","devin","ona","digicert","travis-ci","salesforce","snowflake","datadog","f5-big-ip","godaddy","convex","rundeck","hasura-cloud","qovery","cloud-66","litellm","fireworks","kemp-loadmaster","microsoft-intune","nutanix-prism-central","powerdns","spacelift","daytona","stripe","hpe-ilo"]}},"destination":{"type":"string","enum":["azure-key-vault","aws-certificate-manager","aws-secrets-manager","aws-elastic-load-balancer","chef","gcp-certificate-manager","cloudflare-custom-certificate","netscaler","f5-big-ip","kemp-loadmaster","linux-server","windows-server","nutanix-prism-central"]},"canImportCertificates":{"type":"boolean"},"canRemoveCertificates":{"type":"boolean"},"canRunPostSyncCommand":{"type":"boolean"},"canRunHealthCheckCommand":{"type":"boolean"},"maxCertificates":{"type":"number"},"defaultCertificateNameSchema":{"type":"string"},"forbiddenCharacters":{"type":"string"},"allowedCharacterPattern":{"type":"string"},"maxCertificateNameLength":{"type":"number"},"minCertificateNameLength":{"type":"number"},"unsupportedExportFormats":{"type":"array","items":{"type":"string","enum":["pem","pkcs12","jks"]},"description":"Export formats this instance cannot produce, such as Java KeyStore when running in FIPS mode."}},"required":["name","connection","destination","canImportCertificates","canRemoveCertificates"],"additionalProperties":false}}},"required":["pkiSyncOptions"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs":{"get":{"operationId":"listPkiSyncs","tags":["PKI Syncs"],"description":"List all the PKI Syncs for the specified project.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"certificateId","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"applicationId","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault","aws-certificate-manager","aws-secrets-manager","aws-elastic-load-balancer","chef","gcp-certificate-manager","cloudflare-custom-certificate","netscaler","f5-big-ip","kemp-loadmaster","linux-server","windows-server","nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","additionalProperties":{}},"syncOptions":{"type":"object","additionalProperties":{}},"applicationId":{"type":"string","format":"uuid","nullable":true},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncJobId":{"type":"string","nullable":true},"lastSyncMessage":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"importStatus":{"type":"string","nullable":true},"lastImportJobId":{"type":"string","nullable":true},"lastImportMessage":{"type":"string","nullable":true},"lastImportedAt":{"type":"string","format":"date-time","nullable":true},"removeStatus":{"type":"string","nullable":true},"lastRemoveJobId":{"type":"string","nullable":true},"lastRemoveMessage":{"type":"string","nullable":true},"lastRemovedAt":{"type":"string","format":"date-time","nullable":true},"appConnectionName":{"type":"string"},"appConnectionApp":{"type":"string"},"connection":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"app":{"type":"string"},"encryptedCredentials":{"nullable":true},"orgId":{"type":"string","format":"uuid"},"method":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number"},"gatewayId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","nullable":true}},"required":["id","name","app","orgId","method","version","createdAt","updatedAt"],"additionalProperties":false},"subscriber":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"hasCertificate":{"type":"boolean"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt","appConnectionName","appConnectionApp","connection"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/{pkiSyncId}":{"get":{"operationId":"getPkiSync","tags":["PKI Syncs"],"description":"Get a PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault","aws-certificate-manager","aws-secrets-manager","aws-elastic-load-balancer","chef","gcp-certificate-manager","cloudflare-custom-certificate","netscaler","f5-big-ip","kemp-loadmaster","linux-server","windows-server","nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","additionalProperties":{}},"syncOptions":{"type":"object","additionalProperties":{}},"applicationId":{"type":"string","format":"uuid","nullable":true},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncJobId":{"type":"string","nullable":true},"lastSyncMessage":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"importStatus":{"type":"string","nullable":true},"lastImportJobId":{"type":"string","nullable":true},"lastImportMessage":{"type":"string","nullable":true},"lastImportedAt":{"type":"string","format":"date-time","nullable":true},"removeStatus":{"type":"string","nullable":true},"lastRemoveJobId":{"type":"string","nullable":true},"lastRemoveMessage":{"type":"string","nullable":true},"lastRemovedAt":{"type":"string","format":"date-time","nullable":true},"appConnectionName":{"type":"string"},"appConnectionApp":{"type":"string"},"connection":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"app":{"type":"string"},"encryptedCredentials":{"nullable":true},"orgId":{"type":"string","format":"uuid"},"method":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number"},"gatewayId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","nullable":true}},"required":["id","name","app","orgId","method","version","createdAt","updatedAt"],"additionalProperties":false},"subscriber":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"hasCertificate":{"type":"boolean"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt","appConnectionName","appConnectionApp","connection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/{pkiSyncId}/certificates":{"get":{"operationId":"listPkiSyncCertificates","tags":["PKI Syncs"],"description":"List all certificates associated with a PKI Sync.","parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"pkiSyncId":{"type":"string","format":"uuid"},"certificateId":{"type":"string","format":"uuid"},"syncStatus":{"type":"string","enum":["pending","syncing","succeeded","failed","running"]},"lastSyncMessage":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"certificateSerialNumber":{"type":"string"},"certificateCommonName":{"type":"string"},"certificateOrderId":{"type":"string","format":"uuid"},"certificateAltNames":{"type":"string"},"certificateStatus":{"type":"string"},"certificateNotBefore":{"type":"string","format":"date-time"},"certificateNotAfter":{"type":"string","format":"date-time"},"certificateRenewBeforeDays":{"type":"number","nullable":true},"certificateRenewalError":{"type":"string","nullable":true},"pkiSyncName":{"type":"string"},"pkiSyncDestination":{"type":"string"},"externalIdentifier":{"type":"string","nullable":true},"syncMetadata":{"type":"object","properties":{"isDefault":{"type":"boolean"},"files":{"type":"array","items":{"type":"string"}}},"additionalProperties":{},"nullable":true}},"required":["id","pkiSyncId","certificateId","syncStatus","createdAt","updatedAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["certificates","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"addCertificatesToPkiSync","tags":["PKI Syncs"],"description":"Add certificates to a PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1}},"required":["certificateIds"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"addedCertificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"pkiSyncId":{"type":"string","format":"uuid"},"certificateId":{"type":"string","format":"uuid"},"syncStatus":{"type":"string","default":"pending","nullable":true},"lastSyncMessage":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","pkiSyncId","certificateId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["addedCertificates"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"removeCertificatesFromPkiSync","tags":["PKI Syncs"],"description":"Remove certificates from a PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1}},"required":["certificateIds"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"removedCount":{"type":"number"}},"required":["removedCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/certificates/search":{"post":{"operationId":"searchPkiSyncFilterCertificates","tags":["PKI Syncs"],"description":"List the certificates a set of filters matches, for an existing PKI Sync or an Application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncId":{"type":"string","format":"uuid","description":"Preview the filters against this existing PKI Sync."},"applicationId":{"type":"string","format":"uuid","description":"Preview the filters against this Application, for a PKI Sync that does not exist yet."},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."},"offset":{"type":"number","minimum":0,"default":0,"description":"The offset to start from. If you enter 10, it will start from the 10th matching certificate."},"limit":{"type":"number","minimum":1,"maximum":500,"default":100,"description":"The number of matching certificates to return."}},"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"matchedCount":{"type":"number"},"certificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"commonName":{"type":"string"},"altNames":{"type":"string","nullable":true},"serialNumber":{"type":"string"},"notAfter":{"type":"string","format":"date-time"},"orderId":{"type":"string","format":"uuid"},"profileName":{"type":"string","nullable":true}},"required":["id","commonName"],"additionalProperties":false}},"toUnlink":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"commonName":{"type":"string"},"altNames":{"type":"string","nullable":true},"serialNumber":{"type":"string"},"notAfter":{"type":"string","format":"date-time"},"orderId":{"type":"string","format":"uuid"},"profileName":{"type":"string","nullable":true}},"required":["id","commonName"],"additionalProperties":false}},"willRemoveFromDestination":{"type":"boolean"}},"required":["matchedCount","certificates","toUnlink","willRemoveFromDestination"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/certificate-orders/search":{"post":{"operationId":"searchPkiSyncCertificateOrders","tags":["PKI Syncs"],"description":"Resolve certificate orders to the certificate each one currently holds.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncId":{"type":"string","format":"uuid","description":"Preview the filters against this existing PKI Sync."},"applicationId":{"type":"string","format":"uuid","description":"Preview the filters against this Application, for a PKI Sync that does not exist yet."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":200,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."}},"required":["certificateOrderIds"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"orders":{"type":"array","items":{"type":"object","properties":{"certificateOrderId":{"type":"string","format":"uuid"},"commonName":{"type":"string"},"altNames":{"type":"string","nullable":true}},"required":["certificateOrderId","commonName"],"additionalProperties":false}}},"required":["orders"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/azure-key-vault":{"get":{"operationId":"listAzureKeyVaultPkiSyncs","tags":["PKI Syncs"],"description":"List the Azure Key Vault PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAzureKeyVaultPkiSync","tags":["PKI Syncs"],"description":"Create a Azure Key Vault PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/azure-key-vault/{pkiSyncId}":{"get":{"operationId":"getAzureKeyVaultPkiSync","tags":["PKI Syncs"],"description":"Get the specified Azure Key Vault PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAzureKeyVaultPkiSync","tags":["PKI Syncs"],"description":"Update the specified Azure Key Vault PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAzureKeyVaultPkiSync","tags":["PKI Syncs"],"description":"Delete the specified Azure Key Vault PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/azure-key-vault/{pkiSyncId}/sync":{"post":{"operationId":"syncAzureKeyVaultPkiSync","tags":["PKI Syncs"],"description":"Trigger a sync for the specified Azure Key Vault PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/azure-key-vault/{pkiSyncId}/remove-certificates":{"post":{"operationId":"removeAzureKeyVaultPkiSyncCertificates","tags":["PKI Syncs"],"description":"Remove certificates from the specified Azure Key Vault PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-certificate-manager":{"get":{"operationId":"listAwsCertificateManagerPkiSyncs","tags":["PKI Syncs"],"description":"List the AWS Certificate Manager PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAwsCertificateManagerPkiSync","tags":["PKI Syncs"],"description":"Create a AWS Certificate Manager PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}":{"get":{"operationId":"getAwsCertificateManagerPkiSync","tags":["PKI Syncs"],"description":"Get the specified AWS Certificate Manager PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAwsCertificateManagerPkiSync","tags":["PKI Syncs"],"description":"Update the specified AWS Certificate Manager PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAwsCertificateManagerPkiSync","tags":["PKI Syncs"],"description":"Delete the specified AWS Certificate Manager PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}/sync":{"post":{"operationId":"syncAwsCertificateManagerPkiSync","tags":["PKI Syncs"],"description":"Trigger a sync for the specified AWS Certificate Manager PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-certificate-manager/{pkiSyncId}/remove-certificates":{"post":{"operationId":"removeAwsCertificateManagerPkiSyncCertificates","tags":["PKI Syncs"],"description":"Remove certificates from the specified AWS Certificate Manager PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-secrets-manager":{"get":{"operationId":"listAwsSecretsManagerPkiSyncs","tags":["PKI Syncs"],"description":"List the AWS Secrets Manager PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-secrets-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAwsSecretsManagerPkiSync","tags":["PKI Syncs"],"description":"Create a AWS Secrets Manager PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-secrets-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-secrets-manager/{pkiSyncId}":{"get":{"operationId":"getAwsSecretsManagerPkiSync","tags":["PKI Syncs"],"description":"Get the specified AWS Secrets Manager PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-secrets-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAwsSecretsManagerPkiSync","tags":["PKI Syncs"],"description":"Update the specified AWS Secrets Manager PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-secrets-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAwsSecretsManagerPkiSync","tags":["PKI Syncs"],"description":"Delete the specified AWS Secrets Manager PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-secrets-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-secrets-manager/{pkiSyncId}/sync":{"post":{"operationId":"syncAwsSecretsManagerPkiSync","tags":["PKI Syncs"],"description":"Trigger a sync for the specified AWS Secrets Manager PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-secrets-manager/{pkiSyncId}/remove-certificates":{"post":{"operationId":"removeAwsSecretsManagerPkiSyncCertificates","tags":["PKI Syncs"],"description":"Remove certificates from the specified AWS Secrets Manager PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-elastic-load-balancer":{"get":{"operationId":"listAwsElasticLoadBalancerPkiSyncs","tags":["PKI Syncs"],"description":"List the AWS Elastic Load Balancer PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-elastic-load-balancer"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAwsElasticLoadBalancerPkiSync","tags":["PKI Syncs"],"description":"Create a AWS Elastic Load Balancer PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false,"default":{}},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-elastic-load-balancer"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-elastic-load-balancer/{pkiSyncId}":{"get":{"operationId":"getAwsElasticLoadBalancerPkiSync","tags":["PKI Syncs"],"description":"Get the specified AWS Elastic Load Balancer PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-elastic-load-balancer"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAwsElasticLoadBalancerPkiSync","tags":["PKI Syncs"],"description":"Update the specified AWS Elastic Load Balancer PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-elastic-load-balancer"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAwsElasticLoadBalancerPkiSync","tags":["PKI Syncs"],"description":"Delete the specified AWS Elastic Load Balancer PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-elastic-load-balancer"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-elastic-load-balancer/{pkiSyncId}/sync":{"post":{"operationId":"syncAwsElasticLoadBalancerPkiSync","tags":["PKI Syncs"],"description":"Trigger a sync for the specified AWS Elastic Load Balancer PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-elastic-load-balancer/{pkiSyncId}/remove-certificates":{"post":{"operationId":"removeAwsElasticLoadBalancerPkiSyncCertificates","tags":["PKI Syncs"],"description":"Remove certificates from the specified AWS Elastic Load Balancer PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-elastic-load-balancer/load-balancers":{"get":{"operationId":"listAwsElasticLoadBalancers","description":"List AWS Elastic Load Balancers available for the specified connection and region.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"connectionId","required":true},{"schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"in":"query","name":"region","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"loadBalancers":{"type":"array","items":{"type":"object","properties":{"loadBalancerArn":{"type":"string"},"loadBalancerName":{"type":"string"},"type":{"type":"string","enum":["application","network","gateway"]},"scheme":{"type":"string"},"state":{"type":"string"},"vpcId":{"type":"string"},"dnsName":{"type":"string"}},"required":["loadBalancerArn","loadBalancerName","type","scheme","state"],"additionalProperties":false}}},"required":["loadBalancers"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-elastic-load-balancer/listeners":{"get":{"operationId":"listAwsElasticLoadBalancerListeners","description":"List HTTPS/TLS listeners for the specified AWS Elastic Load Balancer.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"connectionId","required":true},{"schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"in":"query","name":"region","required":true},{"schema":{"type":"string","minLength":1},"in":"query","name":"loadBalancerArn","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string"},"port":{"type":"number"},"protocol":{"type":"string"},"loadBalancerArn":{"type":"string"},"sslPolicy":{"type":"string"},"certificates":{"type":"array","items":{"type":"object","properties":{"certificateArn":{"type":"string"},"isDefault":{"type":"boolean"}},"required":["certificateArn","isDefault"],"additionalProperties":false}}},"required":["listenerArn","port","protocol","loadBalancerArn"],"additionalProperties":false}}},"required":["listeners"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/aws-elastic-load-balancer/{pkiSyncId}/certificates/default":{"post":{"operationId":"setAwsElbCertificateAsDefault","description":"Set a certificate as the default for all listeners in this AWS ELB PKI Sync. This will trigger a sync immediately.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"certificateId":{"type":"string","format":"uuid"}},"required":["certificateId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"clearAwsElbDefaultCertificate","description":"Clear the default certificate for this AWS ELB PKI Sync. No certificate will be set as the default on listeners. This will trigger a sync immediately.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/chef":{"get":{"operationId":"listChefPkiSyncs","tags":["PKI Syncs"],"description":"List the Chef PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["chef"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createChefPkiSync","tags":["PKI Syncs"],"description":"Create a Chef PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["chef"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/chef/{pkiSyncId}":{"get":{"operationId":"getChefPkiSync","tags":["PKI Syncs"],"description":"Get the specified Chef PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["chef"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateChefPkiSync","tags":["PKI Syncs"],"description":"Update the specified Chef PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["chef"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteChefPkiSync","tags":["PKI Syncs"],"description":"Delete the specified Chef PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["chef"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/chef/{pkiSyncId}/sync":{"post":{"operationId":"syncChefPkiSync","tags":["PKI Syncs"],"description":"Trigger a sync for the specified Chef PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/chef/{pkiSyncId}/remove-certificates":{"post":{"operationId":"removeChefPkiSyncCertificates","tags":["PKI Syncs"],"description":"Remove certificates from the specified Chef PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/gcp-certificate-manager":{"get":{"operationId":"listGcpCertificateManagerPkiSyncs","tags":["PKI Syncs"],"description":"List the GCP Certificate Manager PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["gcp-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"],"default":"default"}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createGcpCertificateManagerPkiSync","tags":["PKI Syncs"],"description":"Create a GCP Certificate Manager PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"],"default":"default"}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["gcp-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"],"default":"default"}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/gcp-certificate-manager/{pkiSyncId}":{"get":{"operationId":"getGcpCertificateManagerPkiSync","tags":["PKI Syncs"],"description":"Get the specified GCP Certificate Manager PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["gcp-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"],"default":"default"}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateGcpCertificateManagerPkiSync","tags":["PKI Syncs"],"description":"Update the specified GCP Certificate Manager PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"]}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string","format":"uuid"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["gcp-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"],"default":"default"}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteGcpCertificateManagerPkiSync","tags":["PKI Syncs"],"description":"Delete the specified GCP Certificate Manager PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["gcp-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"],"default":"default"}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/gcp-certificate-manager/{pkiSyncId}/sync":{"post":{"operationId":"syncGcpCertificateManagerPkiSync","tags":["PKI Syncs"],"description":"Trigger a sync for the specified GCP Certificate Manager PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/gcp-certificate-manager/{pkiSyncId}/remove-certificates":{"post":{"operationId":"removeGcpCertificateManagerPkiSyncCertificates","tags":["PKI Syncs"],"description":"Remove certificates from the specified GCP Certificate Manager PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/cloudflare-custom-certificate":{"get":{"operationId":"listCloudflareCustomCertificatePkiSyncs","tags":["PKI Syncs"],"description":"List the Cloudflare Custom SSL Certificate PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["cloudflare-custom-certificate"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createCloudflareCustomCertificatePkiSync","tags":["PKI Syncs"],"description":"Create a Cloudflare Custom SSL Certificate PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["cloudflare-custom-certificate"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/cloudflare-custom-certificate/{pkiSyncId}":{"get":{"operationId":"getCloudflareCustomCertificatePkiSync","tags":["PKI Syncs"],"description":"Get the specified Cloudflare Custom SSL Certificate PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["cloudflare-custom-certificate"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateCloudflareCustomCertificatePkiSync","tags":["PKI Syncs"],"description":"Update the specified Cloudflare Custom SSL Certificate PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["cloudflare-custom-certificate"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteCloudflareCustomCertificatePkiSync","tags":["PKI Syncs"],"description":"Delete the specified Cloudflare Custom SSL Certificate PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["cloudflare-custom-certificate"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/cloudflare-custom-certificate/{pkiSyncId}/sync":{"post":{"operationId":"syncCloudflareCustomCertificatePkiSync","tags":["PKI Syncs"],"description":"Trigger a sync for the specified Cloudflare Custom SSL Certificate PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/cloudflare-custom-certificate/{pkiSyncId}/remove-certificates":{"post":{"operationId":"removeCloudflareCustomCertificatePkiSyncCertificates","tags":["PKI Syncs"],"description":"Remove certificates from the specified Cloudflare Custom SSL Certificate PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/netscaler":{"get":{"operationId":"listNetscalerPkiSyncs","tags":["PKI Syncs"],"description":"List the NetScaler PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["netscaler"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createNetscalerPkiSync","tags":["PKI Syncs"],"description":"Create a NetScaler PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["netscaler"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/netscaler/{pkiSyncId}":{"get":{"operationId":"getNetscalerPkiSync","tags":["PKI Syncs"],"description":"Get the specified NetScaler PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["netscaler"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateNetscalerPkiSync","tags":["PKI Syncs"],"description":"Update the specified NetScaler PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["netscaler"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteNetscalerPkiSync","tags":["PKI Syncs"],"description":"Delete the specified NetScaler PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["netscaler"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/netscaler/{pkiSyncId}/sync":{"post":{"operationId":"syncNetscalerPkiSync","tags":["PKI Syncs"],"description":"Trigger a sync for the specified NetScaler PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/netscaler/{pkiSyncId}/remove-certificates":{"post":{"operationId":"removeNetscalerPkiSyncCertificates","tags":["PKI Syncs"],"description":"Remove certificates from the specified NetScaler PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/f5-big-ip":{"get":{"operationId":"listF5BigIpPkiSyncs","tags":["PKI Syncs"],"description":"List the F5 BIG-IP PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["f5-big-ip"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createF5BigIpPkiSync","tags":["PKI Syncs"],"description":"Create a F5 BIG-IP PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["f5-big-ip"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/f5-big-ip/{pkiSyncId}":{"get":{"operationId":"getF5BigIpPkiSync","tags":["PKI Syncs"],"description":"Get the specified F5 BIG-IP PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["f5-big-ip"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateF5BigIpPkiSync","tags":["PKI Syncs"],"description":"Update the specified F5 BIG-IP PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["f5-big-ip"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteF5BigIpPkiSync","tags":["PKI Syncs"],"description":"Delete the specified F5 BIG-IP PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["f5-big-ip"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/f5-big-ip/{pkiSyncId}/sync":{"post":{"operationId":"syncF5BigIpPkiSync","tags":["PKI Syncs"],"description":"Trigger a sync for the specified F5 BIG-IP PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/f5-big-ip/{pkiSyncId}/remove-certificates":{"post":{"operationId":"removeF5BigIpPkiSyncCertificates","tags":["PKI Syncs"],"description":"Remove certificates from the specified F5 BIG-IP PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/kemp-loadmaster":{"get":{"operationId":"listKempLoadmasterPkiSyncs","tags":["PKI Syncs"],"description":"List the Kemp LoadMaster PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["kemp-loadmaster"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createKempLoadmasterPkiSync","tags":["PKI Syncs"],"description":"Create a Kemp LoadMaster PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["kemp-loadmaster"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/kemp-loadmaster/{pkiSyncId}":{"get":{"operationId":"getKempLoadmasterPkiSync","tags":["PKI Syncs"],"description":"Get the specified Kemp LoadMaster PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["kemp-loadmaster"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateKempLoadmasterPkiSync","tags":["PKI Syncs"],"description":"Update the specified Kemp LoadMaster PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["kemp-loadmaster"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteKempLoadmasterPkiSync","tags":["PKI Syncs"],"description":"Delete the specified Kemp LoadMaster PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["kemp-loadmaster"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/kemp-loadmaster/{pkiSyncId}/sync":{"post":{"operationId":"syncKempLoadmasterPkiSync","tags":["PKI Syncs"],"description":"Trigger a sync for the specified Kemp LoadMaster PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/kemp-loadmaster/{pkiSyncId}/remove-certificates":{"post":{"operationId":"removeKempLoadmasterPkiSyncCertificates","tags":["PKI Syncs"],"description":"Remove certificates from the specified Kemp LoadMaster PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/kemp-loadmaster/virtual-services":{"get":{"operationId":"listKempLoadMasterVirtualServices","description":"List the Virtual Services available on the Kemp LoadMaster for the specified connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"connectionId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"virtualServices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":"string"},"port":{"type":"number"},"protocol":{"type":"string"}},"required":["id","name","address","port","protocol"],"additionalProperties":false}}},"required":["virtualServices"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/linux-server":{"get":{"operationId":"listLinuxServerPkiSyncs","tags":["PKI Syncs"],"description":"List the Linux Server PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["linux-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createLinuxServerPkiSync","tags":["PKI Syncs"],"description":"Create a Linux Server PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"credentials":{"type":"object","properties":{"exportPassword":{"type":"string","minLength":1,"maxLength":1024}},"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["linux-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/linux-server/{pkiSyncId}":{"get":{"operationId":"getLinuxServerPkiSync","tags":["PKI Syncs"],"description":"Get the specified Linux Server PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["linux-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateLinuxServerPkiSync","tags":["PKI Syncs"],"description":"Update the specified Linux Server PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"credentials":{"type":"object","properties":{"exportPassword":{"type":"string","minLength":1,"maxLength":1024}},"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["linux-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteLinuxServerPkiSync","tags":["PKI Syncs"],"description":"Delete the specified Linux Server PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["linux-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/linux-server/test-health-check":{"post":{"operationId":"testLinuxServerPkiSyncHealthCheck","tags":["PKI Syncs"],"description":"Run a health check command against a Linux Server host without saving it to a sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"syncId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":100},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"additionalProperties":false}},"required":["connectionId","destinationConfig","syncOptions"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"healthCheck":{"type":"object","properties":{"status":{"type":"string","enum":["pending","running","succeeded","failed"]},"exitCode":{"type":"number"},"timedOut":{"type":"boolean"},"durationMs":{"type":"number"},"output":{"type":"string"},"failureDetail":{"type":"string"},"message":{"type":"string"}},"required":["status","durationMs"],"additionalProperties":false}},"required":["healthCheck"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/linux-server/{pkiSyncId}/run-health-check":{"post":{"operationId":"runLinuxServerPkiSyncHealthCheck","tags":["PKI Syncs"],"description":"Run the configured health check for the specified Linux Server PKI Sync without delivering certificates.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"healthCheck":{"type":"object","properties":{"status":{"type":"string","enum":["pending","running","succeeded","failed"]},"exitCode":{"type":"number"},"timedOut":{"type":"boolean"},"durationMs":{"type":"number"},"output":{"type":"string"},"failureDetail":{"type":"string"},"message":{"type":"string"}},"required":["status","durationMs"],"additionalProperties":false}},"required":["healthCheck"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/linux-server/{pkiSyncId}/sync":{"post":{"operationId":"syncLinuxServerPkiSync","tags":["PKI Syncs"],"description":"Trigger a sync for the specified Linux Server PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/linux-server/{pkiSyncId}/remove-certificates":{"post":{"operationId":"removeLinuxServerPkiSyncCertificates","tags":["PKI Syncs"],"description":"Remove certificates from the specified Linux Server PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/windows-server":{"get":{"operationId":"listWindowsServerPkiSyncs","tags":["PKI Syncs"],"description":"List the Windows Server PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["windows-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createWindowsServerPkiSync","tags":["PKI Syncs"],"description":"Create a Windows Server PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"credentials":{"type":"object","properties":{"exportPassword":{"type":"string","minLength":1,"maxLength":1024}},"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["windows-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/windows-server/{pkiSyncId}":{"get":{"operationId":"getWindowsServerPkiSync","tags":["PKI Syncs"],"description":"Get the specified Windows Server PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["windows-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateWindowsServerPkiSync","tags":["PKI Syncs"],"description":"Update the specified Windows Server PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"credentials":{"type":"object","properties":{"exportPassword":{"type":"string","minLength":1,"maxLength":1024}},"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["windows-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteWindowsServerPkiSync","tags":["PKI Syncs"],"description":"Delete the specified Windows Server PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["windows-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/windows-server/test-health-check":{"post":{"operationId":"testWindowsServerPkiSyncHealthCheck","tags":["PKI Syncs"],"description":"Run a health check command against a Windows Server host without saving it to a sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"syncId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":100},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"additionalProperties":false}},"required":["connectionId","destinationConfig","syncOptions"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"healthCheck":{"type":"object","properties":{"status":{"type":"string","enum":["pending","running","succeeded","failed"]},"exitCode":{"type":"number"},"timedOut":{"type":"boolean"},"durationMs":{"type":"number"},"output":{"type":"string"},"failureDetail":{"type":"string"},"message":{"type":"string"}},"required":["status","durationMs"],"additionalProperties":false}},"required":["healthCheck"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/windows-server/{pkiSyncId}/run-health-check":{"post":{"operationId":"runWindowsServerPkiSyncHealthCheck","tags":["PKI Syncs"],"description":"Run the configured health check for the specified Windows Server PKI Sync without delivering certificates.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"healthCheck":{"type":"object","properties":{"status":{"type":"string","enum":["pending","running","succeeded","failed"]},"exitCode":{"type":"number"},"timedOut":{"type":"boolean"},"durationMs":{"type":"number"},"output":{"type":"string"},"failureDetail":{"type":"string"},"message":{"type":"string"}},"required":["status","durationMs"],"additionalProperties":false}},"required":["healthCheck"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/windows-server/{pkiSyncId}/sync":{"post":{"operationId":"syncWindowsServerPkiSync","tags":["PKI Syncs"],"description":"Trigger a sync for the specified Windows Server PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/windows-server/{pkiSyncId}/remove-certificates":{"post":{"operationId":"removeWindowsServerPkiSyncCertificates","tags":["PKI Syncs"],"description":"Remove certificates from the specified Windows Server PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/nutanix-prism-central":{"get":{"operationId":"listNutanixPrismCentralPkiSyncs","tags":["PKI Syncs"],"description":"List the Nutanix Prism Central PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createNutanixPrismCentralPkiSync","tags":["PKI Syncs"],"description":"Create a Nutanix Prism Central PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false,"default":{"canImportCertificates":false,"canRemoveCertificates":false}},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/nutanix-prism-central/{pkiSyncId}":{"get":{"operationId":"getNutanixPrismCentralPkiSync","tags":["PKI Syncs"],"description":"Get the specified Nutanix Prism Central PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateNutanixPrismCentralPkiSync","tags":["PKI Syncs"],"description":"Update the specified Nutanix Prism Central PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteNutanixPrismCentralPkiSync","tags":["PKI Syncs"],"description":"Delete the specified Nutanix Prism Central PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/cert-manager/syncs/nutanix-prism-central/{pkiSyncId}/sync":{"post":{"operationId":"syncNutanixPrismCentralPkiSync","tags":["PKI Syncs"],"description":"Trigger a sync for the specified Nutanix Prism Central PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca":{"post":{"operationId":"createCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"description":"Create CA","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectSlug":{"type":"string","description":"Slug of the project to create the CA in."},"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"default":-1,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"default":"RSA_2048","description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"requireTemplateForIssuance":{"type":"boolean","default":false,"description":"Whether or not certificates for this CA can only be issued through certificate templates."}},"required":["projectSlug","type","commonName","organization","ou","country","province","locality"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ca":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"},"status":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"parentCaId":{"type":"string","format":"uuid","nullable":true},"type":{"type":"string"},"friendlyName":{"type":"string"},"organization":{"type":"string"},"ou":{"type":"string"},"country":{"type":"string"},"province":{"type":"string"},"locality":{"type":"string"},"commonName":{"type":"string"},"dn":{"type":"string"},"serialNumber":{"type":"string","nullable":true},"maxPathLength":{"type":"number","nullable":true},"keyAlgorithm":{"type":"string"},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string"},"nullable":true},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false},"isOcspEnabled":{"type":"boolean","default":false},"ocspGeneration":{"type":"number","default":0},"requireTemplateForIssuance":{"type":"boolean"},"notAfter":{"type":"string"},"notBefore":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","status","name","type","friendlyName","organization","ou","country","province","locality","commonName","dn","keyAlgorithm"],"additionalProperties":false}},"required":["ca"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/{caId}":{"get":{"operationId":"getCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"description":"Get CA","parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to get."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ca":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"},"status":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"parentCaId":{"type":"string","format":"uuid","nullable":true},"type":{"type":"string"},"friendlyName":{"type":"string"},"organization":{"type":"string"},"ou":{"type":"string"},"country":{"type":"string"},"province":{"type":"string"},"locality":{"type":"string"},"commonName":{"type":"string"},"dn":{"type":"string"},"serialNumber":{"type":"string","nullable":true},"maxPathLength":{"type":"number","nullable":true},"keyAlgorithm":{"type":"string"},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string"},"nullable":true},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false},"isOcspEnabled":{"type":"boolean","default":false},"ocspGeneration":{"type":"number","default":0},"requireTemplateForIssuance":{"type":"boolean"},"notAfter":{"type":"string"},"notBefore":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","status","name","type","friendlyName","organization","ou","country","province","locality","commonName","dn","keyAlgorithm"],"additionalProperties":false}},"required":["ca"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"description":"Update CA","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["active","disabled"],"description":"The status of the CA to update to. This can be one of active or disabled."},"requireTemplateForIssuance":{"type":"boolean","description":"Whether or not certificates for this CA can only be issued through certificate templates."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to update."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ca":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"},"status":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"parentCaId":{"type":"string","format":"uuid","nullable":true},"type":{"type":"string"},"friendlyName":{"type":"string"},"organization":{"type":"string"},"ou":{"type":"string"},"country":{"type":"string"},"province":{"type":"string"},"locality":{"type":"string"},"commonName":{"type":"string"},"dn":{"type":"string"},"serialNumber":{"type":"string","nullable":true},"maxPathLength":{"type":"number","nullable":true},"keyAlgorithm":{"type":"string"},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string"},"nullable":true},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false},"isOcspEnabled":{"type":"boolean","default":false},"ocspGeneration":{"type":"number","default":0},"requireTemplateForIssuance":{"type":"boolean"},"notAfter":{"type":"string"},"notBefore":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","status","name","type","friendlyName","organization","ou","country","province","locality","commonName","dn","keyAlgorithm"],"additionalProperties":false}},"required":["ca"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteCertificateAuthorityV1","tags":["PKI Certificate Authorities"],"description":"Delete CA","parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to delete."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ca":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"},"status":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"parentCaId":{"type":"string","format":"uuid","nullable":true},"type":{"type":"string"},"friendlyName":{"type":"string"},"organization":{"type":"string"},"ou":{"type":"string"},"country":{"type":"string"},"province":{"type":"string"},"locality":{"type":"string"},"commonName":{"type":"string"},"dn":{"type":"string"},"serialNumber":{"type":"string","nullable":true},"maxPathLength":{"type":"number","nullable":true},"keyAlgorithm":{"type":"string"},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string"},"nullable":true},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false},"isOcspEnabled":{"type":"boolean","default":false},"ocspGeneration":{"type":"number","default":0},"requireTemplateForIssuance":{"type":"boolean"},"notAfter":{"type":"string"},"notBefore":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","status","name","type","friendlyName","organization","ou","country","province","locality","commonName","dn","keyAlgorithm"],"additionalProperties":false}},"required":["ca"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/{caId}/certificates/{caCertId}/der":{"get":{"operationId":"getCertificateAuthorityDerCertificate","tags":["PKI Certificate Authorities"],"description":"Get DER-encoded certificate of CA","parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to get the CA certificate from."},{"schema":{"type":"string"},"in":"path","name":"caCertId","required":true,"description":"The ID of the CA certificate to get."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/{caId}/csr":{"get":{"operationId":"getCertificateAuthorityCsr","tags":["PKI Certificate Authorities"],"description":"Get CA CSR","parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to generate CSR from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"csr":{"type":"string","description":"The generated CSR from the CA."}},"required":["csr"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/{caId}/renew":{"post":{"operationId":"renewCertificateAuthority","tags":["PKI Certificate Authorities"],"description":"Perform CA certificate renewal","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["existing"],"description":"The type of behavior to use for the renewal operation. Currently Infisical is only able to renew a CA certificate with the same key pair."},"notAfter":{"type":"string","description":"The expiry date and time for the renewed CA certificate in YYYY-MM-DDTHH:mm:ss.sssZ format."}},"required":["type","notAfter"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to renew the CA certificate for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The renewed CA certificate body."},"certificateChain":{"type":"string","description":"The certificate chain of the CA."},"serialNumber":{"type":"string","description":"The serial number of the renewed CA certificate."}},"required":["certificate","certificateChain","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/{caId}/ca-certificates":{"get":{"operationId":"listCertificateAuthorityCertificates","tags":["PKI Certificate Authorities"],"description":"Get list of past and current CA certificates for a CA","parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to get the CA certificates for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"certificate":{"type":"string","description":"The certificate body of the CA certificate."},"certificateChain":{"type":"string","description":"The certificate chain of the CA certificate."},"serialNumber":{"type":"string","description":"The serial number of the CA certificate."},"version":{"type":"number","description":"The version of the CA certificate. The version is incremented for each CA renewal operation."}},"required":["certificate","certificateChain","serialNumber","version"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/{caId}/certificate":{"get":{"operationId":"getCertificateAuthorityCertificate","tags":["PKI Certificate Authorities"],"description":"Get current CA cert and cert chain of a CA","parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to get the certificate body and certificate chain from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The certificate body of the CA."},"certificateChain":{"type":"string","description":"The certificate chain of the CA."},"serialNumber":{"type":"string","description":"The serial number of the CA certificate."}},"required":["certificate","certificateChain","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/{caId}/sign-intermediate":{"post":{"operationId":"signIntermediateCertificateAuthority","tags":["PKI Certificate Authorities"],"description":"Create intermediate CA certificate from parent CA","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"csr":{"type":"string","minLength":1,"description":"The pem-encoded CSR to sign with the CA."},"notBefore":{"type":"string","description":"The date and time when the intermediate CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the intermediate CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"default":-1,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."}},"required":["csr","notAfter"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to sign the intermediate certificate with."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The signed intermediate certificate."},"certificateChain":{"type":"string","description":"The certificate chain of the intermediate certificate."},"issuingCaCertificate":{"type":"string","description":"The certificate of the issuing CA."},"serialNumber":{"type":"string","description":"The serial number of the intermediate certificate."}},"required":["certificate","certificateChain","issuingCaCertificate","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/{caId}/import-certificate":{"post":{"operationId":"importCertificateAuthorityCertificate","tags":["PKI Certificate Authorities"],"description":"Import certificate and chain to CA","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The certificate body to import."},"certificateChain":{"type":"string","description":"The certificate chain to import."}},"required":["certificate","certificateChain"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"The ID of the CA to import the certificate for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"caId":{"type":"string"}},"required":["message","caId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/internal":{"get":{"tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"projectId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["internal"]},"configuration":{"type":"object","properties":{"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"default":"","description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"default":"","description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"default":"","description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"default":"","description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"default":"","description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"default":"","description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"nullable":true,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"keySource":{"type":"string","enum":["infisical","hsm"],"description":"Where the CA's signing key is generated and stored. 'infisical' keeps the key in Infisical's KMS; 'hsm' generates and stores the key in the HSM reached through the specified HSM Connector."},"hsmConnectorId":{"type":"string","format":"uuid","description":"The ID of the HSM Connector to generate and store the CA's signing key in. Required when keySource is 'hsm'."},"hsmKeyLabel":{"type":"string","description":"The label of the CA's signing key on the HSM. Not user-supplied: it is the HSM Connector's configured key name prefix followed by a per-CA label built from the CA name and a random 5-character suffix (ca-<name>-<slug>)."},"dn":{"type":"string","maxLength":255,"nullable":true},"parentCaId":{"type":"string","format":"uuid","nullable":true},"serialNumber":{"type":"string","nullable":true},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false,"description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"required":["type","keyAlgorithm"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Internal Certificate Authority to create. Must be slug-friendly."},"projectId":{"type":"string","format":"uuid","description":"The ID of the project to create the Certificate Authority in."},"enableDirectIssuance":{"type":"boolean","description":"Whether or not to enable direct issuance of certificates for the Internal Certificate Authority."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The status of the Internal Certificate Authority."},"configuration":{"type":"object","properties":{"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"default":"","description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"default":"","description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"default":"","description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"default":"","description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"default":"","description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"default":"","description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"nullable":true,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"keySource":{"type":"string","enum":["infisical","hsm"],"description":"Where the CA's signing key is generated and stored. 'infisical' keeps the key in Infisical's KMS; 'hsm' generates and stores the key in the HSM reached through the specified HSM Connector."},"hsmConnectorId":{"type":"string","format":"uuid","description":"The ID of the HSM Connector to generate and store the CA's signing key in. Required when keySource is 'hsm'."},"hsmKeyLabel":{"type":"string","description":"The label of the CA's signing key on the HSM. Not user-supplied: it is the HSM Connector's configured key name prefix followed by a per-CA label built from the CA name and a random 5-character suffix (ca-<name>-<slug>)."},"dn":{"type":"string","maxLength":255,"nullable":true},"parentCaId":{"type":"string","format":"uuid","nullable":true},"serialNumber":{"type":"string","nullable":true},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false,"description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"required":["type","keyAlgorithm"],"additionalProperties":false}},"required":["name","projectId","enableDirectIssuance","status","configuration"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["internal"]},"configuration":{"type":"object","properties":{"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"default":"","description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"default":"","description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"default":"","description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"default":"","description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"default":"","description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"default":"","description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"nullable":true,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"keySource":{"type":"string","enum":["infisical","hsm"],"description":"Where the CA's signing key is generated and stored. 'infisical' keeps the key in Infisical's KMS; 'hsm' generates and stores the key in the HSM reached through the specified HSM Connector."},"hsmConnectorId":{"type":"string","format":"uuid","description":"The ID of the HSM Connector to generate and store the CA's signing key in. Required when keySource is 'hsm'."},"hsmKeyLabel":{"type":"string","description":"The label of the CA's signing key on the HSM. Not user-supplied: it is the HSM Connector's configured key name prefix followed by a per-CA label built from the CA name and a random 5-character suffix (ca-<name>-<slug>)."},"dn":{"type":"string","maxLength":255,"nullable":true},"parentCaId":{"type":"string","format":"uuid","nullable":true},"serialNumber":{"type":"string","nullable":true},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false,"description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"required":["type","keyAlgorithm"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/internal/{caName}":{"get":{"tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"projectId","required":true},{"schema":{"type":"string"},"in":"path","name":"caName","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["internal"]},"configuration":{"type":"object","properties":{"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"default":"","description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"default":"","description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"default":"","description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"default":"","description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"default":"","description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"default":"","description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"nullable":true,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"keySource":{"type":"string","enum":["infisical","hsm"],"description":"Where the CA's signing key is generated and stored. 'infisical' keeps the key in Infisical's KMS; 'hsm' generates and stores the key in the HSM reached through the specified HSM Connector."},"hsmConnectorId":{"type":"string","format":"uuid","description":"The ID of the HSM Connector to generate and store the CA's signing key in. Required when keySource is 'hsm'."},"hsmKeyLabel":{"type":"string","description":"The label of the CA's signing key on the HSM. Not user-supplied: it is the HSM Connector's configured key name prefix followed by a per-CA label built from the CA name and a random 5-character suffix (ca-<name>-<slug>)."},"dn":{"type":"string","maxLength":255,"nullable":true},"parentCaId":{"type":"string","format":"uuid","nullable":true},"serialNumber":{"type":"string","nullable":true},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false,"description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"required":["type","keyAlgorithm"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Internal Certificate Authority. Must be slug-friendly."},"projectId":{"type":"string","format":"uuid","description":"The ID of the project to update the Certificate Authority in."},"enableDirectIssuance":{"type":"boolean","description":"Whether or not to enable direct issuance of certificates for the Internal Certificate Authority."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The updated status of the Internal Certificate Authority."}},"required":["projectId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caName","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["internal"]},"configuration":{"type":"object","properties":{"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"default":"","description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"default":"","description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"default":"","description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"default":"","description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"default":"","description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"default":"","description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"nullable":true,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"keySource":{"type":"string","enum":["infisical","hsm"],"description":"Where the CA's signing key is generated and stored. 'infisical' keeps the key in Infisical's KMS; 'hsm' generates and stores the key in the HSM reached through the specified HSM Connector."},"hsmConnectorId":{"type":"string","format":"uuid","description":"The ID of the HSM Connector to generate and store the CA's signing key in. Required when keySource is 'hsm'."},"hsmKeyLabel":{"type":"string","description":"The label of the CA's signing key on the HSM. Not user-supplied: it is the HSM Connector's configured key name prefix followed by a per-CA label built from the CA name and a random 5-character suffix (ca-<name>-<slug>)."},"dn":{"type":"string","maxLength":255,"nullable":true},"parentCaId":{"type":"string","format":"uuid","nullable":true},"serialNumber":{"type":"string","nullable":true},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false,"description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"required":["type","keyAlgorithm"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","format":"uuid"}},"required":["projectId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caName","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["internal"]},"configuration":{"type":"object","properties":{"type":{"type":"string","enum":["root","intermediate"],"description":"The type of CA to create."},"friendlyName":{"type":"string","maxLength":255,"description":"A friendly name for the CA."},"commonName":{"type":"string","maxLength":255,"default":"","description":"The common name (CN) for the CA."},"organization":{"type":"string","maxLength":255,"default":"","description":"The organization (O) for the CA."},"ou":{"type":"string","maxLength":255,"default":"","description":"The organization unit (OU) for the CA."},"country":{"type":"string","maxLength":255,"default":"","description":"The country name (C) for the CA."},"province":{"type":"string","maxLength":255,"default":"","description":"The state of province name for the CA."},"locality":{"type":"string","maxLength":255,"default":"","description":"The locality name for the CA."},"notBefore":{"type":"string","description":"The date and time when the CA becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the CA expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"maxPathLength":{"type":"number","minimum":-1,"nullable":true,"description":"The maximum number of intermediate CAs that may follow this CA in the certificate / CA chain. A maxPathLength of -1 implies no path limit on the chain."},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"],"description":"The type of public key algorithm and size, in bits, of the key pair for the CA; when you create an intermediate CA, you must use a key algorithm supported by the parent CA."},"keySource":{"type":"string","enum":["infisical","hsm"],"description":"Where the CA's signing key is generated and stored. 'infisical' keeps the key in Infisical's KMS; 'hsm' generates and stores the key in the HSM reached through the specified HSM Connector."},"hsmConnectorId":{"type":"string","format":"uuid","description":"The ID of the HSM Connector to generate and store the CA's signing key in. Required when keySource is 'hsm'."},"hsmKeyLabel":{"type":"string","description":"The label of the CA's signing key on the HSM. Not user-supplied: it is the HSM Connector's configured key name prefix followed by a per-CA label built from the CA name and a random 5-character suffix (ca-<name>-<slug>)."},"dn":{"type":"string","maxLength":255,"nullable":true},"parentCaId":{"type":"string","format":"uuid","nullable":true},"serialNumber":{"type":"string","nullable":true},"activeCaCertId":{"type":"string","format":"uuid","nullable":true},"crlDistributionPointUrls":{"type":"array","items":{"type":"string","maxLength":2048,"format":"uri"},"maxItems":4,"description":"Additional CRL Distribution Point URLs (HTTP/HTTPS) embedded in every certificate issued by this CA. Up to 4 URLs; the Infisical-managed CRL endpoint is included by default unless disabled."},"disableManagedCrlDistributionPointUrl":{"type":"boolean","default":false,"description":"When set to true, the Infisical-managed CRL endpoint URL will not be embedded in certificates issued by this CA. Only custom CRL Distribution Point URLs (if any) will be included."},"isOcspEnabled":{"type":"boolean","description":"When set to true, certificates issued by this CA carry the Infisical-managed OCSP responder URL in their Authority Information Access extension, and that responder answers revocation status queries for them. Applies to certificates issued after it is enabled."}},"required":["type","keyAlgorithm"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/acme":{"get":{"tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"projectId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["acme"]},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the ACME-compatible CA Certificate Authority to create. Must be slug-friendly."},"projectId":{"type":"string","format":"uuid","description":"The ID of the project to create the Certificate Authority in."},"enableDirectIssuance":{"type":"boolean","description":"Whether or not to enable direct issuance of certificates for the ACME-compatible CA Certificate Authority."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The status of the ACME-compatible CA Certificate Authority."},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"eabHmacKey":{"type":"string","maxLength":512,"description":"The External Account Binding (EAB) HMAC key for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["name","projectId","enableDirectIssuance","status","configuration"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["acme"]},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/acme/{caName}":{"get":{"tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"projectId","required":true},{"schema":{"type":"string"},"in":"path","name":"caName","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["acme"]},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the ACME-compatible CA Certificate Authority. Must be slug-friendly."},"projectId":{"type":"string","format":"uuid","description":"The ID of the project to update the Certificate Authority in."},"enableDirectIssuance":{"type":"boolean","description":"Whether or not to enable direct issuance of certificates for the ACME-compatible CA Certificate Authority."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The updated status of the ACME-compatible CA Certificate Authority."},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"eabHmacKey":{"type":"string","maxLength":512,"description":"The External Account Binding (EAB) HMAC key for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["projectId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caName","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["acme"]},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","format":"uuid"}},"required":["projectId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caName","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["acme"]},"configuration":{"type":"object","properties":{"dnsAppConnectionId":{"type":"string","format":"uuid","description":"The ID of the App Connection to use for creating and managing DNS TXT records required for ACME domain validation. This connection must have permissions to create and delete TXT records in your DNS provider (e.g., Route53) for the ACME challenge process."},"dnsProviderConfig":{"type":"object","properties":{"provider":{"type":"string","enum":["route53","cloudflare","dns-made-easy","azure-dns","powerdns","gcp-cloud-dns","ultradns"],"description":"The DNS provider for the ACME Certificate Authority."},"hostedZoneId":{"type":"string","minLength":1,"description":"The hosted zone ID for the ACME Certificate Authority. For Google Cloud DNS, use the managed zone resource name in the format projects/{projectId}/managedZones/{zoneName}."}},"required":["provider","hostedZoneId"],"additionalProperties":false},"directoryUrl":{"type":"string","format":"uri","minLength":1,"description":"The directory URL for the ACME Certificate Authority."},"accountEmail":{"type":"string","minLength":1,"description":"The email address for the ACME Certificate Authority."},"eabKid":{"type":"string","maxLength":64,"description":"The External Account Binding (EAB) Key ID for the ACME Certificate Authority. Required if the ACME provider uses EAB."},"dnsResolver":{"type":"string","anyOf":[{"format":"ipv4"},{"format":"ipv6"}],"description":"An optional custom DNS resolver IP address to use for verifying DNS propagation during ACME challenges. Must be a valid IP address (e.g. 8.8.8.8). When not set, the system default DNS resolver is used."}},"required":["dnsAppConnectionId","dnsProviderConfig","directoryUrl","accountEmail"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/azure-ad-cs":{"get":{"tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"projectId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["azure-ad-cs"]},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Active Directory Certificate Service Certificate Authority to create. Must be slug-friendly."},"projectId":{"type":"string","format":"uuid","description":"The ID of the project to create the Certificate Authority in."},"enableDirectIssuance":{"type":"boolean","description":"Whether or not to enable direct issuance of certificates for the Active Directory Certificate Service Certificate Authority."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The status of the Active Directory Certificate Service Certificate Authority."},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["name","projectId","enableDirectIssuance","status","configuration"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["azure-ad-cs"]},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/azure-ad-cs/{caName}":{"get":{"tags":["PKI Certificate Authorities"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"projectId","required":true},{"schema":{"type":"string"},"in":"path","name":"caName","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["azure-ad-cs"]},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Active Directory Certificate Service Certificate Authority. Must be slug-friendly."},"projectId":{"type":"string","format":"uuid","description":"The ID of the project to update the Certificate Authority in."},"enableDirectIssuance":{"type":"boolean","description":"Whether or not to enable direct issuance of certificates for the Active Directory Certificate Service Certificate Authority."},"status":{"type":"string","enum":["active","disabled","pending-certificate"],"description":"The updated status of the Active Directory Certificate Service Certificate Authority."},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["projectId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caName","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["azure-ad-cs"]},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Certificate Authorities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","format":"uuid"}},"required":["projectId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"caName","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string"},"enableDirectIssuance":{"type":"boolean","default":true},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["active","disabled","pending-certificate"]},"type":{"type":"string","enum":["azure-ad-cs"]},"configuration":{"type":"object","properties":{"azureAdcsConnectionId":{"type":"string","format":"uuid","description":"Azure ADCS Connection ID"}},"required":["azureAdcsConnectionId"],"additionalProperties":false}},"required":["projectId","name","id","status","type","configuration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/ca/azure-ad-cs/{caId}/templates":{"get":{"description":"Get available certificate templates from Azure AD CS CA","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":true,"description":"Project ID"},{"schema":{"type":"string"},"in":"path","name":"caId","required":true,"description":"Azure AD CS CA ID"}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Template identifier"},"name":{"type":"string","description":"Template display name"},"description":{"type":"string","description":"Template description"}},"required":["id","name"],"additionalProperties":false}}},"required":["templates"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificates/{serialNumber}":{"get":{"tags":["PKI Certificates"],"description":"Get certificate","parameters":[{"schema":{"type":"string"},"in":"path","name":"serialNumber","required":true,"description":"The serial number of the certificate to get."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"status":{"type":"string"},"serialNumber":{"type":"string"},"friendlyName":{"type":"string"},"commonName":{"type":"string"},"notBefore":{"type":"string","format":"date-time"},"notAfter":{"type":"string","format":"date-time"},"revokedAt":{"type":"string","format":"date-time","nullable":true},"revocationReason":{"type":"number","nullable":true},"altNames":{"type":"string","nullable":true},"caCertId":{"type":"string","format":"uuid","nullable":true},"certificateTemplateId":{"type":"string","format":"uuid","nullable":true},"keyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"extendedKeyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"projectId":{"type":"string"},"pkiSubscriberId":{"type":"string","format":"uuid","nullable":true},"profileId":{"type":"string","format":"uuid","nullable":true},"renewBeforeDays":{"type":"number","nullable":true},"renewedFromCertificateId":{"type":"string","format":"uuid","nullable":true},"renewedByCertificateId":{"type":"string","format":"uuid","nullable":true},"renewalError":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","nullable":true},"signatureAlgorithm":{"type":"string","nullable":true},"subjectOrganization":{"type":"string","nullable":true},"subjectOrganizationalUnit":{"type":"string","nullable":true},"subjectCountry":{"type":"string","nullable":true},"subjectState":{"type":"string","nullable":true},"subjectLocality":{"type":"string","nullable":true},"fingerprintSha256":{"type":"string","nullable":true},"fingerprintSha1":{"type":"string","nullable":true},"isCA":{"type":"boolean","nullable":true},"pathLength":{"type":"number","nullable":true},"source":{"type":"string","nullable":true},"discoveryMetadata":{"nullable":true},"externalMetadata":{"nullable":true},"applicationId":{"type":"string","format":"uuid","nullable":true},"keySource":{"type":"string","default":"infisical"},"hsmConnectorId":{"type":"string","format":"uuid","nullable":true},"hsmKeyLabel":{"type":"string","nullable":true},"hsmPublicKeySpki":{"nullable":true},"subjectDomainComponents":{"type":"string","nullable":true},"orderId":{"type":"string","format":"uuid","default":"00000000-0000-0000-0000-000000000000"},"customExtensions":{"nullable":true}},"required":["id","createdAt","updatedAt","status","serialNumber","friendlyName","commonName","notBefore","notAfter","projectId"],"additionalProperties":false}},"required":["certificate"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Certificates"],"description":"Delete certificate. Only expired, discovered, or imported certificates can be deleted.","parameters":[{"schema":{"type":"string"},"in":"path","name":"serialNumber","required":true,"description":"The serial number of the certificate to delete."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"status":{"type":"string"},"serialNumber":{"type":"string"},"friendlyName":{"type":"string"},"commonName":{"type":"string"},"notBefore":{"type":"string","format":"date-time"},"notAfter":{"type":"string","format":"date-time"},"revokedAt":{"type":"string","format":"date-time","nullable":true},"revocationReason":{"type":"number","nullable":true},"altNames":{"type":"string","nullable":true},"caCertId":{"type":"string","format":"uuid","nullable":true},"certificateTemplateId":{"type":"string","format":"uuid","nullable":true},"keyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"extendedKeyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"projectId":{"type":"string"},"pkiSubscriberId":{"type":"string","format":"uuid","nullable":true},"profileId":{"type":"string","format":"uuid","nullable":true},"renewBeforeDays":{"type":"number","nullable":true},"renewedFromCertificateId":{"type":"string","format":"uuid","nullable":true},"renewedByCertificateId":{"type":"string","format":"uuid","nullable":true},"renewalError":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","nullable":true},"signatureAlgorithm":{"type":"string","nullable":true},"subjectOrganization":{"type":"string","nullable":true},"subjectOrganizationalUnit":{"type":"string","nullable":true},"subjectCountry":{"type":"string","nullable":true},"subjectState":{"type":"string","nullable":true},"subjectLocality":{"type":"string","nullable":true},"fingerprintSha256":{"type":"string","nullable":true},"fingerprintSha1":{"type":"string","nullable":true},"isCA":{"type":"boolean","nullable":true},"pathLength":{"type":"number","nullable":true},"source":{"type":"string","nullable":true},"discoveryMetadata":{"nullable":true},"externalMetadata":{"nullable":true},"applicationId":{"type":"string","format":"uuid","nullable":true},"keySource":{"type":"string","default":"infisical"},"hsmConnectorId":{"type":"string","format":"uuid","nullable":true},"hsmKeyLabel":{"type":"string","nullable":true},"hsmPublicKeySpki":{"nullable":true},"subjectDomainComponents":{"type":"string","nullable":true},"orderId":{"type":"string","format":"uuid","default":"00000000-0000-0000-0000-000000000000"},"customExtensions":{"nullable":true}},"required":["id","createdAt","updatedAt","status","serialNumber","friendlyName","commonName","notBefore","notAfter","projectId"],"additionalProperties":false}},"required":["certificate"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificates/{serialNumber}/private-key":{"get":{"tags":["PKI Certificates"],"description":"Get certificate private key","parameters":[{"schema":{"type":"string"},"in":"path","name":"serialNumber","required":true,"description":"The serial number of the certificate to get."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificates/{serialNumber}/bundle":{"get":{"tags":["PKI Certificates"],"description":"Get certificate bundle including the certificate, chain, and private key.","parameters":[{"schema":{"type":"string"},"in":"path","name":"serialNumber","required":true,"description":"The serial number of the certificate to get the certificate body and certificate chain for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The certificate body of the certificate."},"certificateChain":{"type":"string","nullable":true,"description":"The certificate chain of the certificate."},"privateKey":{"type":"string","nullable":true,"description":"The private key of the certificate."},"serialNumber":{"type":"string","description":"The serial number of the certificate."}},"required":["certificate","certificateChain","privateKey","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificates/issue-certificate":{"post":{"tags":["PKI Certificates"],"description":"Issue certificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caId":{"type":"string","description":"The ID of the CA to issue the certificate from."},"certificateTemplateId":{"type":"string","description":"The ID of the certificate template to issue the certificate from."},"pkiCollectionId":{"type":"string","description":"The ID of the PKI collection to add the certificate to."},"friendlyName":{"type":"string","description":"A friendly name for the certificate."},"commonName":{"type":"string","minLength":1,"description":"The common name (CN) for the certificate."},"altNames":{"type":"string","default":"","description":"A comma-delimited list of Subject Alternative Names (SANs) for the certificate; these can be host names or email addresses."},"ttl":{"type":"string","description":"The time to live for the certificate such as 1m, 1h, 1d, 1y, ..."},"notBefore":{"type":"string","description":"The date and time when the certificate becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the certificate expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"keyUsages":{"type":"array","items":{"type":"string","enum":["digitalSignature","keyEncipherment","nonRepudiation","dataEncipherment","keyAgreement","keyCertSign","cRLSign","encipherOnly","decipherOnly"]},"description":"The key usage extension of the certificate."},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["clientAuth","serverAuth","codeSigning","emailProtection","timeStamping","ocspSigning","smartCardLogon","anyExtendedKeyUsage"]},"description":"The extended key usage extension of the certificate."}},"required":["commonName","ttl"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The issued certificate."},"issuingCaCertificate":{"type":"string","description":"The certificate of the issuing CA."},"certificateChain":{"type":"string","description":"The certificate chain of the issued certificate."},"privateKey":{"type":"string","description":"The private key of the issued certificate."},"serialNumber":{"type":"string","description":"The serial number of the issued certificate."}},"required":["certificate","issuingCaCertificate","certificateChain","privateKey","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificates/import-certificate":{"post":{"tags":["PKI Certificates"],"description":"Import certificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectSlug":{"type":"string","minLength":1,"description":"Slug of the project to import the certificate into."},"certificatePem":{"type":"string","minLength":1,"description":"The PEM-encoded leaf certificate."},"privateKeyPem":{"type":"string","minLength":1,"description":"Optional PEM-encoded private key associated with the certificate."},"chainPem":{"type":"string","minLength":1,"description":"Optional PEM-encoded chain of intermediate certificates."},"friendlyName":{"type":"string","description":"A friendly name for the certificate."},"pkiCollectionId":{"type":"string","description":"The ID of the PKI collection to add the certificate to."}},"required":["projectSlug","certificatePem"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The imported certificate."},"certificateChain":{"type":"string","description":"The certificate chain associated with the imported certificate. Returned only when a chain was supplied at import."},"privateKey":{"type":"string","description":"The PEM-encoded private key associated with the imported certificate. Returned only when a private key was supplied at import."},"serialNumber":{"type":"string","description":"The serial number of the imported certificate."}},"required":["certificate","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificates/sign-certificate":{"post":{"tags":["PKI Certificates"],"description":"Sign certificate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caId":{"type":"string","description":"The ID of the CA to issue the certificate from."},"certificateTemplateId":{"type":"string","description":"The ID of the certificate template to issue the certificate from."},"pkiCollectionId":{"type":"string","description":"The ID of the PKI collection to add the certificate to."},"csr":{"type":"string","minLength":1,"description":"The pem-encoded CSR to sign with the CA to be used for certificate issuance."},"friendlyName":{"type":"string","description":"A friendly name for the certificate."},"commonName":{"type":"string","minLength":1,"description":"The common name (CN) for the certificate."},"altNames":{"type":"string","default":"","description":"A comma-delimited list of Subject Alternative Names (SANs) for the certificate; these can be host names or email addresses."},"ttl":{"type":"string","description":"The time to live for the certificate such as 1m, 1h, 1d, 1y, ..."},"notBefore":{"type":"string","description":"The date and time when the certificate becomes valid in YYYY-MM-DDTHH:mm:ss.sssZ format."},"notAfter":{"type":"string","description":"The date and time when the certificate expires in YYYY-MM-DDTHH:mm:ss.sssZ format."},"keyUsages":{"type":"array","items":{"type":"string","enum":["digitalSignature","keyEncipherment","nonRepudiation","dataEncipherment","keyAgreement","keyCertSign","cRLSign","encipherOnly","decipherOnly"]},"description":"The key usage extension of the certificate."},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["clientAuth","serverAuth","codeSigning","emailProtection","timeStamping","ocspSigning","smartCardLogon","anyExtendedKeyUsage"]},"description":"The extended key usage extension of the certificate."}},"required":["csr","ttl"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The issued certificate."},"issuingCaCertificate":{"type":"string","description":"The certificate of the issuing CA."},"certificateChain":{"type":"string","description":"The certificate chain of the issued certificate."},"serialNumber":{"type":"string","description":"The serial number of the issued certificate."}},"required":["certificate","issuingCaCertificate","certificateChain","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificates/{serialNumber}/revoke":{"post":{"tags":["PKI Certificates"],"description":"Revoke","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"revocationReason":{"type":"string","enum":["UNSPECIFIED","KEY_COMPROMISE","CA_COMPROMISE","AFFILIATION_CHANGED","SUPERSEDED","CESSATION_OF_OPERATION","CERTIFICATE_HOLD","PRIVILEGE_WITHDRAWN","A_A_COMPROMISE"],"description":"The reason for revoking the certificate."}},"required":["revocationReason"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"serialNumber","required":true,"description":"The serial number of the certificate to revoke. The revoked certificate will be added to the certificate revocation list (CRL) of the CA."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"serialNumber":{"type":"string","description":"The serial number of the revoked certificate."},"revokedAt":{"type":"string","format":"date-time","description":"The date and time when the certificate was revoked."}},"required":["message","serialNumber","revokedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificates/{serialNumber}/certificate":{"get":{"tags":["PKI Certificates"],"description":"Get certificate body of certificate","parameters":[{"schema":{"type":"string"},"in":"path","name":"serialNumber","required":true,"description":"The serial number of the certificate to get the certificate body and certificate chain for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The certificate body of the certificate."},"certificateChain":{"type":"string","nullable":true,"description":"The certificate chain of the certificate."},"serialNumber":{"type":"string","description":"The serial number of the certificate."}},"required":["certificate","certificateChain","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificate-templates/{certificateTemplateId}":{"get":{"tags":["PKI Certificate Templates"],"description":"Deprecated. Use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","parameters":[{"schema":{"type":"string"},"in":"path","name":"certificateTemplateId","required":true,"description":"The ID of the certificate template to get."}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid"},"name":{"type":"string"},"commonName":{"type":"string"},"subjectAlternativeName":{"type":"string"},"pkiCollectionId":{"type":"string","format":"uuid","nullable":true},"ttl":{"type":"string"},"keyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"extendedKeyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"projectId":{"type":"string"},"caName":{"type":"string"}},"required":["id","caId","name","commonName","subjectAlternativeName","ttl","projectId","caName"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Certificate Templates"],"description":"Deprecated. Use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caId":{"type":"string","description":"The ID of the certificate authority to update the association with the template."},"pkiCollectionId":{"type":"string","description":"The ID of the PKI collection to update the binding to the template."},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the template."},"commonName":{"type":"string","minLength":1,"maxLength":100,"description":"The updated regular expression string for validating common names."},"subjectAlternativeName":{"type":"string","minLength":1,"maxLength":100,"description":"The updated regular expression string for validating subject alternative names."},"ttl":{"type":"string","description":"The updated max TTL for the template."},"keyUsages":{"type":"array","items":{"type":"string","enum":["digitalSignature","keyEncipherment","nonRepudiation","dataEncipherment","keyAgreement","keyCertSign","cRLSign","encipherOnly","decipherOnly"]},"description":"The updated key usage constraint or default value for when template is used during certificate issuance."},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["clientAuth","serverAuth","codeSigning","emailProtection","timeStamping","ocspSigning","smartCardLogon","anyExtendedKeyUsage"]},"description":"The updated extended key usage constraint or default value for when template is used during certificate issuance."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"certificateTemplateId","required":true,"description":"The ID of the certificate template to update."}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid"},"name":{"type":"string"},"commonName":{"type":"string"},"subjectAlternativeName":{"type":"string"},"pkiCollectionId":{"type":"string","format":"uuid","nullable":true},"ttl":{"type":"string"},"keyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"extendedKeyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"projectId":{"type":"string"},"caName":{"type":"string"}},"required":["id","caId","name","commonName","subjectAlternativeName","ttl","projectId","caName"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Certificate Templates"],"description":"Deprecated. Use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","parameters":[{"schema":{"type":"string"},"in":"path","name":"certificateTemplateId","required":true,"description":"The ID of the certificate template to delete."}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid"},"name":{"type":"string"},"commonName":{"type":"string"},"subjectAlternativeName":{"type":"string"},"pkiCollectionId":{"type":"string","format":"uuid","nullable":true},"ttl":{"type":"string"},"keyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"extendedKeyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"projectId":{"type":"string"},"caName":{"type":"string"}},"required":["id","caId","name","commonName","subjectAlternativeName","ttl","projectId","caName"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificate-templates":{"post":{"tags":["PKI Certificate Templates"],"description":"Deprecated. Use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caId":{"type":"string","description":"The ID of the certificate authority to associate the template with."},"pkiCollectionId":{"type":"string","description":"The ID of the PKI collection to bind to the template."},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the template."},"commonName":{"type":"string","minLength":1,"maxLength":100,"description":"The regular expression string to use for validating common names."},"subjectAlternativeName":{"type":"string","minLength":1,"maxLength":100,"description":"The regular expression string to use for validating subject alternative names."},"ttl":{"type":"string","description":"The max TTL for the template."},"keyUsages":{"type":"array","items":{"type":"string","enum":["digitalSignature","keyEncipherment","nonRepudiation","dataEncipherment","keyAgreement","keyCertSign","cRLSign","encipherOnly","decipherOnly"]},"default":["digitalSignature","keyEncipherment"],"description":"The key usage constraint or default value for when template is used during certificate issuance."},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["clientAuth","serverAuth","codeSigning","emailProtection","timeStamping","ocspSigning","smartCardLogon","anyExtendedKeyUsage"]},"default":[],"description":"The extended key usage constraint or default value for when template is used during certificate issuance."}},"required":["caId","name","commonName","subjectAlternativeName","ttl"],"additionalProperties":false}}}},"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"caId":{"type":"string","format":"uuid"},"name":{"type":"string"},"commonName":{"type":"string"},"subjectAlternativeName":{"type":"string"},"pkiCollectionId":{"type":"string","format":"uuid","nullable":true},"ttl":{"type":"string"},"keyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"extendedKeyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"projectId":{"type":"string"},"caName":{"type":"string"}},"required":["id","caId","name","commonName","subjectAlternativeName","ttl","projectId","caName"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificate-templates/{certificateTemplateId}/est-config":{"post":{"tags":["PKI Certificate Templates"],"description":"Create Certificate Template EST configuration. Deprecated, use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caChain":{"type":"string"},"passphrase":{"type":"string","minLength":1},"isEnabled":{"type":"boolean","default":true},"disableBootstrapCertValidation":{"type":"boolean","default":false}},"required":["passphrase"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"certificateTemplateId","required":true}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"certificateTemplateId":{"type":"string","format":"uuid"},"isEnabled":{"type":"boolean"},"disableBootstrapCertValidation":{"type":"boolean","default":false}},"required":["id","certificateTemplateId","isEnabled"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Certificate Templates"],"description":"Update Certificate Template EST configuration. Deprecated, use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caChain":{"type":"string"},"passphrase":{"type":"string","minLength":1},"disableBootstrapCertValidation":{"type":"boolean"},"isEnabled":{"type":"boolean"}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"certificateTemplateId","required":true}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"certificateTemplateId":{"type":"string","format":"uuid"},"isEnabled":{"type":"boolean"},"disableBootstrapCertValidation":{"type":"boolean","default":false}},"required":["id","certificateTemplateId","isEnabled"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"tags":["PKI Certificate Templates"],"description":"Get Certificate Template EST configuration. Deprecated, use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","parameters":[{"schema":{"type":"string"},"in":"path","name":"certificateTemplateId","required":true}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"certificateTemplateId":{"type":"string","format":"uuid"},"isEnabled":{"type":"boolean"},"disableBootstrapCertValidation":{"type":"boolean","default":false},"caChain":{"type":"string"}},"required":["id","certificateTemplateId","isEnabled","caChain"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificate-profiles":{"post":{"tags":["PKI Certificate Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caId":{"type":"string","format":"uuid"},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-z0-9-]+$"},"description":{"type":"string","maxLength":255},"issuerType":{"type":"string","enum":["ca","self-signed"],"default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"integer","exclusiveMinimum":true,"minimum":0},"commonName":{"type":"string","maxLength":255},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"integer","minimum":0}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string","maxLength":255},"organizationalUnit":{"type":"string","maxLength":255},"country":{"type":"string","maxLength":255},"state":{"type":"string","maxLength":255},"locality":{"type":"string","maxLength":255},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"maxItems":50},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true}},"required":["certificatePolicyId","slug"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateProfile":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"caId":{"type":"string","format":"uuid","nullable":true},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"enrollmentType":{"type":"string"},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"issuerType":{"type":"string","default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"number"},"commonName":{"type":"string"},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"locality":{"type":"string"},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string"}},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true}},"required":["id","projectId","certificatePolicyId","slug","enrollmentType","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificateProfile"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"tags":["PKI Certificate Profiles"],"parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"string"},"in":"query","name":"search","required":false},{"schema":{"type":"string","enum":["api","est","acme","scep"]},"in":"query","name":"enrollmentType","required":false},{"schema":{"type":"string","enum":["ca","self-signed"]},"in":"query","name":"issuerType","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"caId","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"applicationId","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateProfiles":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"caId":{"type":"string","format":"uuid","nullable":true},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"enrollmentType":{"type":"string"},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"issuerType":{"type":"string","default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"number"},"commonName":{"type":"string"},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"locality":{"type":"string"},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string"}},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true},"certificateAuthority":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"name":{"type":"string"},"isExternal":{"type":"boolean"},"externalType":{"type":"string","nullable":true},"productNameId":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","nullable":true}},"required":["id","status","name"],"additionalProperties":false},"metrics":{"type":"object","properties":{"profileId":{"type":"string"},"totalCertificates":{"type":"number"},"activeCertificates":{"type":"number"},"expiredCertificates":{"type":"number"},"expiringCertificates":{"type":"number"},"revokedCertificates":{"type":"number"}},"required":["profileId","totalCertificates","activeCertificates","expiredCertificates","expiringCertificates","revokedCertificates"],"additionalProperties":false},"estConfig":{"type":"object","properties":{"id":{"type":"string"},"disableBootstrapCaValidation":{"type":"boolean"},"passphrase":{"type":"string"},"caChain":{"type":"string"}},"required":["id","disableBootstrapCaValidation"],"additionalProperties":false},"apiConfig":{"type":"object","properties":{"id":{"type":"string"},"autoRenew":{"type":"boolean"},"renewBeforeDays":{"type":"number"}},"required":["id","autoRenew"],"additionalProperties":false},"acmeConfig":{"type":"object","properties":{"id":{"type":"string"},"directoryUrl":{"type":"string"},"skipDnsOwnershipVerification":{"type":"boolean"},"skipEabBinding":{"type":"boolean"}},"required":["id","directoryUrl"],"additionalProperties":false},"scepConfig":{"type":"object","properties":{"id":{"type":"string"},"scepEndpointUrl":{"type":"string"},"raCertificatePem":{"type":"string"},"raCertExpiresAt":{"type":"string","format":"date-time"},"includeCaCertInResponse":{"type":"boolean"},"allowCertBasedRenewal":{"type":"boolean"},"challengeType":{"type":"string"},"challengeEndpointUrl":{"type":"string"},"dynamicChallengeExpiryMinutes":{"type":"number"},"dynamicChallengeMaxPending":{"type":"number"}},"required":["id","scepEndpointUrl","raCertificatePem","raCertExpiresAt","includeCaCertInResponse","allowCertBasedRenewal","challengeType"],"additionalProperties":false}},"required":["id","projectId","certificatePolicyId","slug","enrollmentType","createdAt","updatedAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["certificateProfiles","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificate-profiles/{id}":{"get":{"tags":["PKI Certificate Profiles"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateProfile":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"caId":{"type":"string","format":"uuid","nullable":true},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"enrollmentType":{"type":"string"},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"issuerType":{"type":"string","default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"number"},"commonName":{"type":"string"},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"locality":{"type":"string"},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string"}},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true},"certificateAuthority":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"status":{"type":"string"},"name":{"type":"string"},"isExternal":{"type":"boolean"},"externalType":{"type":"string","nullable":true},"productNameId":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","nullable":true}},"required":["id","projectId","status","name"],"additionalProperties":false},"certificatePolicy":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}},"required":["id","projectId","name"],"additionalProperties":false},"estConfig":{"type":"object","properties":{"id":{"type":"string"},"disableBootstrapCaValidation":{"type":"boolean"},"caChain":{"type":"string"}},"required":["id","disableBootstrapCaValidation"],"additionalProperties":false},"apiConfig":{"type":"object","properties":{"id":{"type":"string"},"autoRenew":{"type":"boolean"},"renewBeforeDays":{"type":"number"}},"required":["id","autoRenew"],"additionalProperties":false},"acmeConfig":{"type":"object","properties":{"id":{"type":"string"},"directoryUrl":{"type":"string"},"skipDnsOwnershipVerification":{"type":"boolean"},"skipEabBinding":{"type":"boolean"}},"required":["id","directoryUrl"],"additionalProperties":false},"scepConfig":{"type":"object","properties":{"id":{"type":"string"},"scepEndpointUrl":{"type":"string"},"raCertificatePem":{"type":"string"},"raCertExpiresAt":{"type":"string","format":"date-time"},"includeCaCertInResponse":{"type":"boolean"},"allowCertBasedRenewal":{"type":"boolean"},"challengeType":{"type":"string"},"challengeEndpointUrl":{"type":"string"},"dynamicChallengeExpiryMinutes":{"type":"number"},"dynamicChallengeMaxPending":{"type":"number"}},"required":["id","scepEndpointUrl","raCertificatePem","raCertExpiresAt","includeCaCertInResponse","allowCertBasedRenewal","challengeType"],"additionalProperties":false}},"required":["id","projectId","certificatePolicyId","slug","enrollmentType","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificateProfile"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Certificate Profiles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-z0-9-]+$"},"description":{"type":"string","maxLength":255,"nullable":true},"issuerType":{"type":"string","enum":["ca","self-signed"]},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"integer","exclusiveMinimum":true,"minimum":0},"commonName":{"type":"string","maxLength":255},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"integer","minimum":0}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string","maxLength":255},"organizationalUnit":{"type":"string","maxLength":255},"country":{"type":"string","maxLength":255},"state":{"type":"string","maxLength":255},"locality":{"type":"string","maxLength":255},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string","minLength":1,"maxLength":255},"maxItems":50},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateProfile":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"caId":{"type":"string","format":"uuid","nullable":true},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"enrollmentType":{"type":"string"},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"issuerType":{"type":"string","default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"number"},"commonName":{"type":"string"},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"locality":{"type":"string"},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string"}},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true}},"required":["id","projectId","certificatePolicyId","slug","enrollmentType","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificateProfile"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Certificate Profiles"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateProfile":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"caId":{"type":"string","format":"uuid","nullable":true},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"enrollmentType":{"type":"string"},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"issuerType":{"type":"string","default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"number"},"commonName":{"type":"string"},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"locality":{"type":"string"},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string"}},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true}},"required":["id","projectId","certificatePolicyId","slug","enrollmentType","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificateProfile"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificate-profiles/slug/{slug}":{"get":{"tags":["PKI Certificate Profiles"],"parameters":[{"schema":{"type":"string","minLength":1},"in":"path","name":"slug","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificateProfile":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"caId":{"type":"string","format":"uuid","nullable":true},"certificatePolicyId":{"type":"string","format":"uuid"},"slug":{"type":"string"},"description":{"type":"string","nullable":true},"enrollmentType":{"type":"string"},"estConfigId":{"type":"string","format":"uuid","nullable":true},"apiConfigId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"acmeConfigId":{"type":"string","format":"uuid","nullable":true},"issuerType":{"type":"string","default":"ca"},"externalConfigs":{"anyOf":[{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Azure AD CS"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{"template":{"type":"string","minLength":1,"description":"Certificate template name for Active Directory Certificate Service"}},"required":["template"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}],"nullable":true},"defaults":{"type":"object","properties":{"ttlDays":{"type":"number"},"commonName":{"type":"string"},"keyAlgorithm":{"type":"string","enum":["RSA_2048","RSA_3072","RSA_4096","EC_prime256v1","EC_secp384r1","EC_secp521r1","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"signatureAlgorithm":{"type":"string","enum":["RSA-SHA256","RSA-SHA384","RSA-SHA512","ECDSA-SHA256","ECDSA-SHA384","ECDSA-SHA512","ML-DSA-44","ML-DSA-65","ML-DSA-87","SLH-DSA-SHA2-128f","SLH-DSA-SHA2-128s","SLH-DSA-SHA2-192f","SLH-DSA-SHA2-192s","SLH-DSA-SHA2-256f","SLH-DSA-SHA2-256s","SLH-DSA-SHAKE-128f","SLH-DSA-SHAKE-128s","SLH-DSA-SHAKE-192f","SLH-DSA-SHAKE-192s","SLH-DSA-SHAKE-256f","SLH-DSA-SHAKE-256s"]},"keyUsages":{"type":"array","items":{"type":"string","enum":["digital_signature","key_encipherment","non_repudiation","data_encipherment","key_agreement","key_cert_sign","crl_sign","encipher_only","decipher_only"]}},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["client_auth","server_auth","code_signing","email_protection","ocsp_signing","smart_card_logon","time_stamping","any_purpose"]}},"basicConstraints":{"type":"object","properties":{"isCA":{"type":"boolean"},"pathLength":{"type":"number"}},"required":["isCA"],"additionalProperties":false},"organization":{"type":"string"},"organizationalUnit":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"locality":{"type":"string"},"subjectAltNames":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["dns_name","ip_address","email","uri","upn"]},"value":{"type":"string","minLength":1}},"required":["type","value"],"additionalProperties":false}},"domainComponents":{"type":"array","items":{"type":"string"}},"customExtensions":{"type":"array","items":{"type":"object","properties":{"oid":{"type":"string","maxLength":64},"label":{"type":"string","minLength":1,"maxLength":64},"critical":{"type":"boolean"},"value":{"type":"string","minLength":1,"maxLength":4096}},"required":["oid"],"additionalProperties":false},"maxItems":10}},"additionalProperties":false,"nullable":true},"scepConfigId":{"type":"string","format":"uuid","nullable":true}},"required":["id","projectId","certificatePolicyId","slug","enrollmentType","createdAt","updatedAt"],"additionalProperties":false}},"required":["certificateProfile"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificate-profiles/{id}/certificates":{"get":{"tags":["PKI Certificate Profiles"],"parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"string","enum":["active","expired","revoked","renewed"]},"in":"query","name":"status","required":false},{"schema":{"type":"string"},"in":"query","name":"search","required":false},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"serialNumber":{"type":"string"},"cn":{"type":"string"},"status":{"type":"string"},"notBefore":{"type":"string","format":"date-time"},"notAfter":{"type":"string","format":"date-time"},"revokedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"}},"required":["id","serialNumber","cn","status","notBefore","notAfter","createdAt"],"additionalProperties":false}}},"required":["certificates"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificate-profiles/{id}/certificates/latest-active-bundle":{"get":{"tags":["PKI Certificate Profiles"],"description":"Get latest active certificate bundle for a profile","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","nullable":true},"certificateChain":{"type":"string","nullable":true},"privateKey":{"type":"string","nullable":true},"serialNumber":{"type":"string","nullable":true}},"required":["certificate","certificateChain","privateKey","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/certificate-profiles/{id}/acme/eab-secret/reveal":{"get":{"tags":["PKI Certificate Profiles"],"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"eabKid":{"type":"string"},"eabSecret":{"type":"string"}},"required":["eabKid","eabSecret"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/collections":{"post":{"tags":["PKI Certificate Collections"],"description":"Create PKI collection","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","description":"The ID of the project to create the PKI collection in."},"name":{"type":"string","description":"The name of the PKI collection."},"description":{"type":"string","default":"","description":"A description for the PKI collection."}},"required":["projectId","name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","name","description"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/collections/{collectionId}":{"get":{"operationId":"getPkiCollection","tags":["PKI Certificate Collections"],"description":"Get PKI collection","parameters":[{"schema":{"type":"string"},"in":"path","name":"collectionId","required":true,"description":"The ID of the PKI collection to get."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","name","description"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePkiCollection","tags":["PKI Certificate Collections"],"description":"Update PKI collection","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the PKI collection to update to."},"description":{"type":"string","description":"The description for the PKI collection to update to."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"collectionId","required":true,"description":"The ID of the PKI collection to update."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","name","description"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deletePkiCollection","tags":["PKI Certificate Collections"],"description":"Delete PKI collection","parameters":[{"schema":{"type":"string"},"in":"path","name":"collectionId","required":true,"description":"The ID of the PKI collection to delete."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","name","description"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/collections/{collectionId}/items":{"get":{"operationId":"listPkiCollectionItems","tags":["PKI Certificate Collections"],"description":"Get items in PKI collection","parameters":[{"schema":{"type":"string","enum":["certificate","ca"]},"in":"query","name":"type","required":false,"description":"The type of the PKI collection item to list."},{"schema":{"type":"number","minimum":0,"maximum":100,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from."},{"schema":{"type":"number","minimum":1,"maximum":100,"default":25},"in":"query","name":"limit","required":false,"description":"The number of items to return."},{"schema":{"type":"string"},"in":"path","name":"collectionId","required":true,"description":"The ID of the PKI collection to list items from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"collectionItems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"pkiCollectionId":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["certificate","ca"]},"itemId":{"type":"string"},"notBefore":{"type":"string","format":"date-time"},"notAfter":{"type":"string","format":"date-time"},"friendlyName":{"type":"string"}},"required":["id","createdAt","updatedAt","pkiCollectionId","type","itemId","notBefore","notAfter","friendlyName"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["collectionItems","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"addItemToPkiCollection","tags":["PKI Certificate Collections"],"description":"Add item to PKI collection","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["certificate","ca"],"description":"The type of the PKI collection item to add."},"itemId":{"type":"string","description":"The resource ID of the PKI collection item to add."}},"required":["type","itemId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"collectionId","required":true,"description":"The ID of the PKI collection to add the item to."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"pkiCollectionId":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["certificate","ca"],"description":"The type of the PKI collection item to add."},"itemId":{"type":"string","description":"The resource ID of the PKI collection item to add."}},"required":["id","createdAt","updatedAt","pkiCollectionId","type","itemId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/collections/{collectionId}/items/{collectionItemId}":{"delete":{"operationId":"removeItemFromPkiCollection","tags":["PKI Certificate Collections"],"description":"Remove item from PKI collection","parameters":[{"schema":{"type":"string"},"in":"path","name":"collectionId","required":true,"description":"The ID of the PKI collection to delete the item from."},{"schema":{"type":"string"},"in":"path","name":"collectionItemId","required":true,"description":"The ID of the PKI collection item to delete."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"pkiCollectionId":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["certificate","ca"],"description":"The type of the deleted PKI collection item."},"itemId":{"type":"string","description":"The resource ID of the deleted PKI collection item."}},"required":["id","createdAt","updatedAt","pkiCollectionId","type","itemId"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/subscribers/{subscriberName}":{"get":{"operationId":"getPkiSubscriber","tags":["PKI Subscribers"],"description":"Get PKI Subscriber. Deprecated, use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":true,"description":"The ID of the project to get the PKI subscriber for."},{"schema":{"type":"string"},"in":"path","name":"subscriberName","required":true,"description":"The name of the PKI subscriber to get."}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"caId":{"type":"string","format":"uuid","nullable":true},"name":{"type":"string"},"commonName":{"type":"string"},"status":{"type":"string"},"subjectAlternativeNames":{"type":"array","items":{"type":"string"}},"ttl":{"type":"string","nullable":true},"keyUsages":{"type":"array","items":{"type":"string"}},"extendedKeyUsages":{"type":"array","items":{"type":"string"}},"lastOperationStatus":{"type":"string","nullable":true},"lastOperationMessage":{"type":"string","nullable":true},"lastOperationAt":{"type":"string","format":"date-time","nullable":true},"enableAutoRenewal":{"type":"boolean","default":false},"autoRenewalPeriodInDays":{"type":"number","nullable":true},"lastAutoRenewAt":{"type":"string","format":"date-time","nullable":true},"properties":{"nullable":true},"supportsImmediateCertIssuance":{"type":"boolean"}},"required":["id","projectId","name","commonName","status","subjectAlternativeNames","keyUsages","extendedKeyUsages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePkiSubscriber","tags":["PKI Subscribers"],"description":"Update PKI Subscriber. Deprecated, use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","description":"The ID of the project to update the PKI subscriber in."},"caId":{"type":"string","format":"uuid","minLength":1,"description":"The ID of the CA that will issue certificates for the PKI subscriber to update to."},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the PKI subscriber to update to."},"commonName":{"type":"string","minLength":1,"description":"The common name (CN) to be used on certificates issued for this subscriber to update to."},"status":{"type":"string","enum":["active","disabled"],"description":"The status of the PKI subscriber to update to. This can be one of active or disabled."},"subjectAlternativeNames":{"type":"array","items":{"type":"string"},"description":"A comma-delimited list of Subject Alternative Names (SANs) to be used on certificates issued for this subscriber; these can be host names or email addresses."},"ttl":{"type":"string","description":"The time to live for the certificates issued for this subscriber such as 1m, 1h, 1d, 1y, ..."},"keyUsages":{"type":"array","items":{"type":"string","enum":["digitalSignature","keyEncipherment","nonRepudiation","dataEncipherment","keyAgreement","keyCertSign","cRLSign","encipherOnly","decipherOnly"]},"description":"The key usage extension to be used on certificates issued for this subscriber to update to."},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["clientAuth","serverAuth","codeSigning","emailProtection","timeStamping","ocspSigning","smartCardLogon","anyExtendedKeyUsage"]},"description":"The extended key usage extension to be used on certificates issued for this subscriber to update to."},"enableAutoRenewal":{"type":"boolean","description":"Whether or not to enable auto renewal for the PKI subscriber."},"autoRenewalPeriodInDays":{"type":"number","minimum":1,"description":"The period in days to auto renew the PKI subscriber's certificates."},"properties":{"type":"object","properties":{"azureTemplateType":{"type":"string","description":"Azure ADCS Certificate Template Type"},"organization":{"type":"string","minLength":1,"maxLength":64,"allOf":[{"pattern":"^[^,=+<>#;\\\\\"\\/\\r\\n\\t]*$"},{"pattern":"^[^\\\\s\\\\-_.]+.*[^\\\\s\\\\-_.]+$|^[^\\\\s\\\\-_.]{1}$"}],"description":"Organization (O) - Maximum 64 characters, no special DN characters"},"organizationalUnit":{"type":"string","minLength":1,"maxLength":64,"allOf":[{"pattern":"^[^,=+<>#;\\\\\"\\/\\r\\n\\t]*$"},{"pattern":"^[^\\\\s\\\\-_.]+.*[^\\\\s\\\\-_.]+$|^[^\\\\s\\\\-_.]{1}$"}],"description":"Organizational Unit (OU) - Maximum 64 characters, no special DN characters"},"country":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","description":"Country (C) - Two uppercase letter country code (e.g., US, CA, GB)"},"state":{"type":"string","minLength":1,"maxLength":64,"allOf":[{"pattern":"^[^,=+<>#;\\\\\"\\/\\r\\n\\t]*$"},{"pattern":"^[^\\\\s\\\\-_.]+.*[^\\\\s\\\\-_.]+$|^[^\\\\s\\\\-_.]{1}$"}],"description":"State/Province (ST) - Maximum 64 characters, no special DN characters"},"locality":{"type":"string","minLength":1,"maxLength":64,"allOf":[{"pattern":"^[^,=+<>#;\\\\\"\\/\\r\\n\\t]*$"},{"pattern":"^[^\\\\s\\\\-_.]+.*[^\\\\s\\\\-_.]+$|^[^\\\\s\\\\-_.]{1}$"}],"description":"Locality (L) - Maximum 64 characters, no special DN characters"},"emailAddress":{"type":"string","format":"email","minLength":6,"maxLength":64,"description":"Email Address - Valid email format between 6 and 64 characters"}},"additionalProperties":false,"description":"Additional subscriber properties and subject fields"}},"required":["projectId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"subscriberName","required":true,"description":"The name of the PKI subscriber to update."}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"caId":{"type":"string","format":"uuid","nullable":true},"name":{"type":"string"},"commonName":{"type":"string"},"status":{"type":"string"},"subjectAlternativeNames":{"type":"array","items":{"type":"string"}},"ttl":{"type":"string","nullable":true},"keyUsages":{"type":"array","items":{"type":"string"}},"extendedKeyUsages":{"type":"array","items":{"type":"string"}},"lastOperationStatus":{"type":"string","nullable":true},"lastOperationMessage":{"type":"string","nullable":true},"lastOperationAt":{"type":"string","format":"date-time","nullable":true},"enableAutoRenewal":{"type":"boolean","default":false},"autoRenewalPeriodInDays":{"type":"number","nullable":true},"lastAutoRenewAt":{"type":"string","format":"date-time","nullable":true},"properties":{"nullable":true},"supportsImmediateCertIssuance":{"type":"boolean"}},"required":["id","projectId","name","commonName","status","subjectAlternativeNames","keyUsages","extendedKeyUsages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Subscribers"],"description":"Delete PKI Subscriber. Deprecated, use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","description":"The ID of the project of the PKI subscriber to delete."}},"required":["projectId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"subscriberName","required":true,"description":"The name of the PKI subscriber to delete."}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"caId":{"type":"string","format":"uuid","nullable":true},"name":{"type":"string"},"commonName":{"type":"string"},"status":{"type":"string"},"subjectAlternativeNames":{"type":"array","items":{"type":"string"}},"ttl":{"type":"string","nullable":true},"keyUsages":{"type":"array","items":{"type":"string"}},"extendedKeyUsages":{"type":"array","items":{"type":"string"}},"lastOperationStatus":{"type":"string","nullable":true},"lastOperationMessage":{"type":"string","nullable":true},"lastOperationAt":{"type":"string","format":"date-time","nullable":true},"enableAutoRenewal":{"type":"boolean","default":false},"autoRenewalPeriodInDays":{"type":"number","nullable":true},"lastAutoRenewAt":{"type":"string","format":"date-time","nullable":true},"properties":{"nullable":true},"supportsImmediateCertIssuance":{"type":"boolean"}},"required":["id","projectId","name","commonName","status","subjectAlternativeNames","keyUsages","extendedKeyUsages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/subscribers":{"post":{"operationId":"createPkiSubscriber","tags":["PKI Subscribers"],"description":"Create PKI Subscriber. Deprecated, use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","description":"The ID of the project to create the PKI subscriber in."},"caId":{"type":"string","format":"uuid","minLength":1,"description":"The ID of the CA that will issue certificates for the PKI subscriber."},"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the PKI subscriber."},"commonName":{"type":"string","minLength":1,"description":"The common name (CN) to be used on certificates issued for this subscriber."},"status":{"type":"string","enum":["active","disabled"],"default":"active","description":"The status of the PKI subscriber. This can be one of active or disabled."},"ttl":{"type":"string","description":"The time to live for the certificates issued for this subscriber such as 1m, 1h, 1d, 1y, ..."},"subjectAlternativeNames":{"type":"array","items":{"type":"string"},"default":[],"description":"A list of Subject Alternative Names (SANs) to be used on certificates issued for this subscriber; these can be host names or email addresses."},"keyUsages":{"type":"array","items":{"type":"string","enum":["digitalSignature","keyEncipherment","nonRepudiation","dataEncipherment","keyAgreement","keyCertSign","cRLSign","encipherOnly","decipherOnly"]},"default":["digitalSignature","keyEncipherment"],"description":"The key usage extension to be used on certificates issued for this subscriber."},"extendedKeyUsages":{"type":"array","items":{"type":"string","enum":["clientAuth","serverAuth","codeSigning","emailProtection","timeStamping","ocspSigning","smartCardLogon","anyExtendedKeyUsage"]},"default":[],"description":"The extended key usage extension to be used on certificates issued for this subscriber."},"enableAutoRenewal":{"type":"boolean","description":"Whether or not to enable auto renewal for the PKI subscriber."},"autoRenewalPeriodInDays":{"type":"number","minimum":1,"description":"The period in days to auto renew the PKI subscriber's certificates."},"properties":{"type":"object","properties":{"azureTemplateType":{"type":"string","description":"Azure ADCS Certificate Template Type"},"organization":{"type":"string","minLength":1,"maxLength":64,"allOf":[{"pattern":"^[^,=+<>#;\\\\\"\\/\\r\\n\\t]*$"},{"pattern":"^[^\\\\s\\\\-_.]+.*[^\\\\s\\\\-_.]+$|^[^\\\\s\\\\-_.]{1}$"}],"description":"Organization (O) - Maximum 64 characters, no special DN characters"},"organizationalUnit":{"type":"string","minLength":1,"maxLength":64,"allOf":[{"pattern":"^[^,=+<>#;\\\\\"\\/\\r\\n\\t]*$"},{"pattern":"^[^\\\\s\\\\-_.]+.*[^\\\\s\\\\-_.]+$|^[^\\\\s\\\\-_.]{1}$"}],"description":"Organizational Unit (OU) - Maximum 64 characters, no special DN characters"},"country":{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Z]{2}$","description":"Country (C) - Two uppercase letter country code (e.g., US, CA, GB)"},"state":{"type":"string","minLength":1,"maxLength":64,"allOf":[{"pattern":"^[^,=+<>#;\\\\\"\\/\\r\\n\\t]*$"},{"pattern":"^[^\\\\s\\\\-_.]+.*[^\\\\s\\\\-_.]+$|^[^\\\\s\\\\-_.]{1}$"}],"description":"State/Province (ST) - Maximum 64 characters, no special DN characters"},"locality":{"type":"string","minLength":1,"maxLength":64,"allOf":[{"pattern":"^[^,=+<>#;\\\\\"\\/\\r\\n\\t]*$"},{"pattern":"^[^\\\\s\\\\-_.]+.*[^\\\\s\\\\-_.]+$|^[^\\\\s\\\\-_.]{1}$"}],"description":"Locality (L) - Maximum 64 characters, no special DN characters"},"emailAddress":{"type":"string","format":"email","minLength":6,"maxLength":64,"description":"Email Address - Valid email format between 6 and 64 characters"}},"additionalProperties":false,"description":"Additional subscriber properties and subject fields"}},"required":["projectId","caId","name","commonName"],"additionalProperties":false}}}},"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"caId":{"type":"string","format":"uuid","nullable":true},"name":{"type":"string"},"commonName":{"type":"string"},"status":{"type":"string"},"subjectAlternativeNames":{"type":"array","items":{"type":"string"}},"ttl":{"type":"string","nullable":true},"keyUsages":{"type":"array","items":{"type":"string"}},"extendedKeyUsages":{"type":"array","items":{"type":"string"}},"lastOperationStatus":{"type":"string","nullable":true},"lastOperationMessage":{"type":"string","nullable":true},"lastOperationAt":{"type":"string","format":"date-time","nullable":true},"enableAutoRenewal":{"type":"boolean","default":false},"autoRenewalPeriodInDays":{"type":"number","nullable":true},"lastAutoRenewAt":{"type":"string","format":"date-time","nullable":true},"properties":{"nullable":true},"supportsImmediateCertIssuance":{"type":"boolean"}},"required":["id","projectId","name","commonName","status","subjectAlternativeNames","keyUsages","extendedKeyUsages"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/subscribers/{subscriberName}/order-certificate":{"post":{"operationId":"orderPkiSubscriberCertificate","tags":["PKI Subscribers"],"description":"Order certificate. Deprecated, use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","description":"The ID of the project of the PKI subscriber to issue the certificate for."}},"required":["projectId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"subscriberName","required":true,"description":"The name of the PKI subscriber to issue the certificate for."}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/subscribers/{subscriberName}/issue-certificate":{"post":{"operationId":"issuePkiSubscriberCertificate","tags":["PKI Subscribers"],"description":"Issue certificate. Deprecated, use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","description":"The ID of the project of the PKI subscriber to issue the certificate for."}},"required":["projectId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"subscriberName","required":true,"description":"The name of the PKI subscriber to issue the certificate for."}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The issued certificate."},"issuingCaCertificate":{"type":"string","description":"The certificate of the issuing CA."},"certificateChain":{"type":"string","description":"The certificate chain of the issued certificate."},"privateKey":{"type":"string","description":"The private key of the issued certificate."},"serialNumber":{"type":"string","description":"The serial number of the issued certificate."}},"required":["certificate","issuingCaCertificate","certificateChain","privateKey","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/subscribers/{subscriberName}/sign-certificate":{"post":{"operationId":"signPkiSubscriberCertificate","tags":["PKI Subscribers"],"description":"Sign certificate. Deprecated, use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","description":"The ID of the project of the PKI subscriber to sign the certificate for."},"csr":{"type":"string","minLength":1,"maxLength":3000,"description":"The CSR to be used to sign the certificate."}},"required":["projectId","csr"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"subscriberName","required":true,"description":"The name of the PKI subscriber to sign the certificate for."}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The signed certificate."},"issuingCaCertificate":{"type":"string","description":"The certificate of the issuing CA."},"certificateChain":{"type":"string","description":"The certificate chain of the signed certificate."},"serialNumber":{"type":"string","description":"The serial number of the issued certificate."}},"required":["certificate","issuingCaCertificate","certificateChain","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/subscribers/{subscriberName}/latest-certificate-bundle":{"get":{"operationId":"getPkiSubscriberLatestCertificateBundle","tags":["PKI Subscribers"],"description":"Get latest certificate bundle of a subscriber. Deprecated, use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":true,"description":"The ID of the project to get the active certificate bundle for."},{"schema":{"type":"string"},"in":"path","name":"subscriberName","required":true,"description":"The name of the PKI subscriber to get the active certificate bundle for."}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificate":{"type":"string","description":"The active certificate for the subscriber."},"certificateChain":{"type":"string","nullable":true,"description":"The certificate chain of the active certificate for the subscriber."},"privateKey":{"type":"string","description":"The private key of the active certificate for the subscriber."},"serialNumber":{"type":"string","description":"The serial number of the active certificate for the subscriber."}},"required":["certificate","certificateChain","privateKey","serialNumber"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/subscribers/{subscriberName}/certificates":{"get":{"operationId":"listPkiSubscriberCertificates","tags":["PKI Subscribers"],"description":"List PKI Subscriber certificates. Deprecated, use certificate applications instead: https://infisical.com/docs/documentation/platform/pki/applications/overview","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":true,"description":"The ID of the project of the PKI subscriber to list the certificates for."},{"schema":{"type":"number","minimum":0,"maximum":100,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from."},{"schema":{"type":"number","minimum":1,"maximum":100,"default":25},"in":"query","name":"limit","required":false,"description":"The number of certificates to return."},{"schema":{"type":"string"},"in":"path","name":"subscriberName","required":true,"description":"The name of the PKI subscriber to get."}],"deprecated":true,"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"caId":{"type":"string","format":"uuid","nullable":true},"status":{"type":"string"},"serialNumber":{"type":"string"},"friendlyName":{"type":"string"},"commonName":{"type":"string"},"notBefore":{"type":"string","format":"date-time"},"notAfter":{"type":"string","format":"date-time"},"revokedAt":{"type":"string","format":"date-time","nullable":true},"revocationReason":{"type":"number","nullable":true},"altNames":{"type":"string","nullable":true},"caCertId":{"type":"string","format":"uuid","nullable":true},"certificateTemplateId":{"type":"string","format":"uuid","nullable":true},"keyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"extendedKeyUsages":{"type":"array","items":{"type":"string"},"nullable":true},"projectId":{"type":"string"},"pkiSubscriberId":{"type":"string","format":"uuid","nullable":true},"profileId":{"type":"string","format":"uuid","nullable":true},"renewBeforeDays":{"type":"number","nullable":true},"renewedFromCertificateId":{"type":"string","format":"uuid","nullable":true},"renewedByCertificateId":{"type":"string","format":"uuid","nullable":true},"renewalError":{"type":"string","nullable":true},"keyAlgorithm":{"type":"string","nullable":true},"signatureAlgorithm":{"type":"string","nullable":true},"subjectOrganization":{"type":"string","nullable":true},"subjectOrganizationalUnit":{"type":"string","nullable":true},"subjectCountry":{"type":"string","nullable":true},"subjectState":{"type":"string","nullable":true},"subjectLocality":{"type":"string","nullable":true},"fingerprintSha256":{"type":"string","nullable":true},"fingerprintSha1":{"type":"string","nullable":true},"isCA":{"type":"boolean","nullable":true},"pathLength":{"type":"number","nullable":true},"source":{"type":"string","nullable":true},"discoveryMetadata":{"nullable":true},"externalMetadata":{"nullable":true},"applicationId":{"type":"string","format":"uuid","nullable":true},"keySource":{"type":"string","default":"infisical"},"hsmConnectorId":{"type":"string","format":"uuid","nullable":true},"hsmKeyLabel":{"type":"string","nullable":true},"hsmPublicKeySpki":{"nullable":true},"subjectDomainComponents":{"type":"string","nullable":true},"orderId":{"type":"string","format":"uuid","default":"00000000-0000-0000-0000-000000000000"},"customExtensions":{"nullable":true}},"required":["id","createdAt","updatedAt","status","serialNumber","friendlyName","commonName","notBefore","notAfter","projectId"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["certificates","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/options":{"get":{"tags":["PKI Syncs"],"description":"List the available PKI Sync Options.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncOptions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"connection":{"type":"string","enum":["github","github-radar","aws","databricks","gcp","azure-key-vault","azure-app-configuration","azure-client-secrets","azure-devops","azure-adcs","adcs","azure-dns","humanitec","terraform-cloud","vercel","postgres","mssql","mysql","camunda","windmill","auth0","hashicorp-vault","ldap","teamcity","oci","oracledb","1password","heroku","render","flyio","trigger-dev","gitlab","cloudflare","dns-made-easy","ultradns","zabbix","railway","bitbucket","checkly","supabase","digital-ocean","netlify","okta","redis","mongodb","laravel-forge","chef","northflank","octopus-deploy","ssh","dbt","smb","winrm","open-router","openai","circleci","azure-entra-id","venafi","venafi-tpp","external-infisical","doppler","netscaler","anthropic","ovh","devin","ona","digicert","travis-ci","salesforce","snowflake","datadog","f5-big-ip","godaddy","convex","rundeck","hasura-cloud","qovery","cloud-66","litellm","fireworks","kemp-loadmaster","microsoft-intune","nutanix-prism-central","powerdns","spacelift","daytona","stripe","hpe-ilo"]},"additionalConnections":{"type":"array","items":{"type":"string","enum":["github","github-radar","aws","databricks","gcp","azure-key-vault","azure-app-configuration","azure-client-secrets","azure-devops","azure-adcs","adcs","azure-dns","humanitec","terraform-cloud","vercel","postgres","mssql","mysql","camunda","windmill","auth0","hashicorp-vault","ldap","teamcity","oci","oracledb","1password","heroku","render","flyio","trigger-dev","gitlab","cloudflare","dns-made-easy","ultradns","zabbix","railway","bitbucket","checkly","supabase","digital-ocean","netlify","okta","redis","mongodb","laravel-forge","chef","northflank","octopus-deploy","ssh","dbt","smb","winrm","open-router","openai","circleci","azure-entra-id","venafi","venafi-tpp","external-infisical","doppler","netscaler","anthropic","ovh","devin","ona","digicert","travis-ci","salesforce","snowflake","datadog","f5-big-ip","godaddy","convex","rundeck","hasura-cloud","qovery","cloud-66","litellm","fireworks","kemp-loadmaster","microsoft-intune","nutanix-prism-central","powerdns","spacelift","daytona","stripe","hpe-ilo"]}},"destination":{"type":"string","enum":["azure-key-vault","aws-certificate-manager","aws-secrets-manager","aws-elastic-load-balancer","chef","gcp-certificate-manager","cloudflare-custom-certificate","netscaler","f5-big-ip","kemp-loadmaster","linux-server","windows-server","nutanix-prism-central"]},"canImportCertificates":{"type":"boolean"},"canRemoveCertificates":{"type":"boolean"},"canRunPostSyncCommand":{"type":"boolean"},"canRunHealthCheckCommand":{"type":"boolean"},"maxCertificates":{"type":"number"},"defaultCertificateNameSchema":{"type":"string"},"forbiddenCharacters":{"type":"string"},"allowedCharacterPattern":{"type":"string"},"maxCertificateNameLength":{"type":"number"},"minCertificateNameLength":{"type":"number"},"unsupportedExportFormats":{"type":"array","items":{"type":"string","enum":["pem","pkcs12","jks"]},"description":"Export formats this instance cannot produce, such as Java KeyStore when running in FIPS mode."}},"required":["name","connection","destination","canImportCertificates","canRemoveCertificates"],"additionalProperties":false}}},"required":["pkiSyncOptions"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs":{"get":{"tags":["PKI Syncs"],"description":"List all the PKI Syncs for the specified project.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"certificateId","required":false},{"schema":{"type":"string","format":"uuid"},"in":"query","name":"applicationId","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault","aws-certificate-manager","aws-secrets-manager","aws-elastic-load-balancer","chef","gcp-certificate-manager","cloudflare-custom-certificate","netscaler","f5-big-ip","kemp-loadmaster","linux-server","windows-server","nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","additionalProperties":{}},"syncOptions":{"type":"object","additionalProperties":{}},"projectId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid","nullable":true},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncJobId":{"type":"string","nullable":true},"lastSyncMessage":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"importStatus":{"type":"string","nullable":true},"lastImportJobId":{"type":"string","nullable":true},"lastImportMessage":{"type":"string","nullable":true},"lastImportedAt":{"type":"string","format":"date-time","nullable":true},"removeStatus":{"type":"string","nullable":true},"lastRemoveJobId":{"type":"string","nullable":true},"lastRemoveMessage":{"type":"string","nullable":true},"lastRemovedAt":{"type":"string","format":"date-time","nullable":true},"appConnectionName":{"type":"string"},"appConnectionApp":{"type":"string"},"connection":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"app":{"type":"string"},"encryptedCredentials":{"nullable":true},"orgId":{"type":"string","format":"uuid"},"projectId":{"type":"string","format":"uuid","nullable":true},"method":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number"},"gatewayId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","nullable":true}},"required":["id","name","app","orgId","method","version","createdAt","updatedAt"],"additionalProperties":false},"subscriber":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"hasCertificate":{"type":"boolean"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt","appConnectionName","appConnectionApp","connection"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get a PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault","aws-certificate-manager","aws-secrets-manager","aws-elastic-load-balancer","chef","gcp-certificate-manager","cloudflare-custom-certificate","netscaler","f5-big-ip","kemp-loadmaster","linux-server","windows-server","nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","additionalProperties":{}},"syncOptions":{"type":"object","additionalProperties":{}},"projectId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid","nullable":true},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncJobId":{"type":"string","nullable":true},"lastSyncMessage":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"importStatus":{"type":"string","nullable":true},"lastImportJobId":{"type":"string","nullable":true},"lastImportMessage":{"type":"string","nullable":true},"lastImportedAt":{"type":"string","format":"date-time","nullable":true},"removeStatus":{"type":"string","nullable":true},"lastRemoveJobId":{"type":"string","nullable":true},"lastRemoveMessage":{"type":"string","nullable":true},"lastRemovedAt":{"type":"string","format":"date-time","nullable":true},"appConnectionName":{"type":"string"},"appConnectionApp":{"type":"string"},"connection":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"app":{"type":"string"},"encryptedCredentials":{"nullable":true},"orgId":{"type":"string","format":"uuid"},"projectId":{"type":"string","format":"uuid","nullable":true},"method":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number"},"gatewayId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","nullable":true}},"required":["id","name","app","orgId","method","version","createdAt","updatedAt"],"additionalProperties":false},"subscriber":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false,"nullable":true},"hasCertificate":{"type":"boolean"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt","appConnectionName","appConnectionApp","connection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/{pkiSyncId}/certificates":{"get":{"tags":["PKI Syncs"],"description":"List all certificates associated with a PKI Sync.","parameters":[{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false},{"schema":{"type":"number","minimum":1,"maximum":100,"default":20},"in":"query","name":"limit","required":false},{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"certificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"pkiSyncId":{"type":"string","format":"uuid"},"certificateId":{"type":"string","format":"uuid"},"syncStatus":{"type":"string","enum":["pending","syncing","succeeded","failed","running"]},"lastSyncMessage":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"certificateSerialNumber":{"type":"string"},"certificateCommonName":{"type":"string"},"certificateOrderId":{"type":"string","format":"uuid"},"certificateAltNames":{"type":"string"},"certificateStatus":{"type":"string"},"certificateNotBefore":{"type":"string","format":"date-time"},"certificateNotAfter":{"type":"string","format":"date-time"},"certificateRenewBeforeDays":{"type":"number","nullable":true},"certificateRenewalError":{"type":"string","nullable":true},"pkiSyncName":{"type":"string"},"pkiSyncDestination":{"type":"string"},"externalIdentifier":{"type":"string","nullable":true},"syncMetadata":{"type":"object","properties":{"isDefault":{"type":"boolean"},"files":{"type":"array","items":{"type":"string"}}},"additionalProperties":{},"nullable":true}},"required":["id","pkiSyncId","certificateId","syncStatus","createdAt","updatedAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["certificates","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Add certificates to a PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1}},"required":["certificateIds"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"addedCertificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"pkiSyncId":{"type":"string","format":"uuid"},"certificateId":{"type":"string","format":"uuid"},"syncStatus":{"type":"string","default":"pending","nullable":true},"lastSyncMessage":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","pkiSyncId","certificateId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["addedCertificates"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Remove certificates from a PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1}},"required":["certificateIds"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"removedCount":{"type":"number"}},"required":["removedCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/certificates/search":{"post":{"tags":["PKI Syncs"],"description":"List the certificates a set of filters matches, for an existing PKI Sync or an Application.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncId":{"type":"string","format":"uuid","description":"Preview the filters against this existing PKI Sync."},"applicationId":{"type":"string","format":"uuid","description":"Preview the filters against this Application, for a PKI Sync that does not exist yet."},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."},"offset":{"type":"number","minimum":0,"default":0,"description":"The offset to start from. If you enter 10, it will start from the 10th matching certificate."},"limit":{"type":"number","minimum":1,"maximum":500,"default":100,"description":"The number of matching certificates to return."}},"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"matchedCount":{"type":"number"},"certificates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"commonName":{"type":"string"},"altNames":{"type":"string","nullable":true},"serialNumber":{"type":"string"},"notAfter":{"type":"string","format":"date-time"},"orderId":{"type":"string","format":"uuid"},"profileName":{"type":"string","nullable":true}},"required":["id","commonName"],"additionalProperties":false}},"toUnlink":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"commonName":{"type":"string"},"altNames":{"type":"string","nullable":true},"serialNumber":{"type":"string"},"notAfter":{"type":"string","format":"date-time"},"orderId":{"type":"string","format":"uuid"},"profileName":{"type":"string","nullable":true}},"required":["id","commonName"],"additionalProperties":false}},"willRemoveFromDestination":{"type":"boolean"}},"required":["matchedCount","certificates","toUnlink","willRemoveFromDestination"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/certificate-orders/search":{"post":{"tags":["PKI Syncs"],"description":"Resolve certificate orders to the certificate each one currently holds.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncId":{"type":"string","format":"uuid","description":"Preview the filters against this existing PKI Sync."},"applicationId":{"type":"string","format":"uuid","description":"Preview the filters against this Application, for a PKI Sync that does not exist yet."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":200,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."}},"required":["certificateOrderIds"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"orders":{"type":"array","items":{"type":"object","properties":{"certificateOrderId":{"type":"string","format":"uuid"},"commonName":{"type":"string"},"altNames":{"type":"string","nullable":true}},"required":["certificateOrderId","commonName"],"additionalProperties":false}}},"required":["orders"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/azure-key-vault":{"get":{"tags":["PKI Syncs"],"description":"List the Azure Key Vault PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Create a Azure Key Vault PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/azure-key-vault/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get the specified Azure Key Vault PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Syncs"],"description":"Update the specified Azure Key Vault PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Delete the specified Azure Key Vault PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["azure-key-vault"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vaultBaseUrl":{"type":"string","format":"uri"}},"required":["vaultBaseUrl"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"enableVersioning":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/azure-key-vault/{pkiSyncId}/sync":{"post":{"tags":["PKI Syncs"],"description":"Trigger a sync for the specified Azure Key Vault PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/azure-key-vault/{pkiSyncId}/remove-certificates":{"post":{"tags":["PKI Syncs"],"description":"Remove certificates from the specified Azure Key Vault PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-certificate-manager":{"get":{"tags":["PKI Syncs"],"description":"List the AWS Certificate Manager PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Create a AWS Certificate Manager PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-certificate-manager/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get the specified AWS Certificate Manager PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Syncs"],"description":"Update the specified AWS Certificate Manager PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Delete the specified AWS Certificate Manager PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-certificate-manager/{pkiSyncId}/sync":{"post":{"tags":["PKI Syncs"],"description":"Trigger a sync for the specified AWS Certificate Manager PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-certificate-manager/{pkiSyncId}/remove-certificates":{"post":{"tags":["PKI Syncs"],"description":"Remove certificates from the specified AWS Certificate Manager PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-secrets-manager":{"get":{"tags":["PKI Syncs"],"description":"List the AWS Secrets Manager PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-secrets-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Create a AWS Secrets Manager PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-secrets-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-secrets-manager/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get the specified AWS Secrets Manager PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-secrets-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Syncs"],"description":"Update the specified AWS Secrets Manager PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-secrets-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Delete the specified AWS Secrets Manager PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-secrets-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"keyId":{"type":"string"}},"required":["region"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveSecretOnRenewal":{"type":"boolean","default":true},"updateExistingCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-secrets-manager/{pkiSyncId}/sync":{"post":{"tags":["PKI Syncs"],"description":"Trigger a sync for the specified AWS Secrets Manager PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-secrets-manager/{pkiSyncId}/remove-certificates":{"post":{"tags":["PKI Syncs"],"description":"Remove certificates from the specified AWS Secrets Manager PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-elastic-load-balancer":{"get":{"tags":["PKI Syncs"],"description":"List the AWS Elastic Load Balancer PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-elastic-load-balancer"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Create a AWS Elastic Load Balancer PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false,"default":{}},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-elastic-load-balancer"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-elastic-load-balancer/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get the specified AWS Elastic Load Balancer PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-elastic-load-balancer"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Syncs"],"description":"Update the specified AWS Elastic Load Balancer PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-elastic-load-balancer"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Delete the specified AWS Elastic Load Balancer PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["aws-elastic-load-balancer"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"loadBalancerArn":{"type":"string","minLength":1},"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string","minLength":1},"port":{"type":"integer","exclusiveMinimum":true,"minimum":0},"protocol":{"type":"string","minLength":1},"setAsDefault":{"type":"boolean"}},"required":["listenerArn","port","protocol"],"additionalProperties":false},"minItems":1}},"required":["region","loadBalancerArn","listeners"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","default":false},"canRemoveCertificates":{"type":"boolean","default":false},"preserveArn":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"certificateNameSchema":{"type":"string"},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-elastic-load-balancer/{pkiSyncId}/sync":{"post":{"tags":["PKI Syncs"],"description":"Trigger a sync for the specified AWS Elastic Load Balancer PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-elastic-load-balancer/{pkiSyncId}/remove-certificates":{"post":{"tags":["PKI Syncs"],"description":"Remove certificates from the specified AWS Elastic Load Balancer PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-elastic-load-balancer/load-balancers":{"get":{"description":"List AWS Elastic Load Balancers available for the specified connection and region.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"connectionId","required":true},{"schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"in":"query","name":"region","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"loadBalancers":{"type":"array","items":{"type":"object","properties":{"loadBalancerArn":{"type":"string"},"loadBalancerName":{"type":"string"},"type":{"type":"string","enum":["application","network","gateway"]},"scheme":{"type":"string"},"state":{"type":"string"},"vpcId":{"type":"string"},"dnsName":{"type":"string"}},"required":["loadBalancerArn","loadBalancerName","type","scheme","state"],"additionalProperties":false}}},"required":["loadBalancers"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-elastic-load-balancer/listeners":{"get":{"description":"List HTTPS/TLS listeners for the specified AWS Elastic Load Balancer.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"connectionId","required":true},{"schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-east-1","us-gov-west-1","af-south-1","ap-east-1","ap-south-1","ap-south-2","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-southeast-3","ap-southeast-4","ca-central-1","eu-central-1","eu-central-2","eu-west-1","eu-west-2","eu-west-3","eu-south-1","eu-south-2","eu-north-1","me-south-1","me-central-1","sa-east-1"]},"in":"query","name":"region","required":true},{"schema":{"type":"string","minLength":1},"in":"query","name":"loadBalancerArn","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"listeners":{"type":"array","items":{"type":"object","properties":{"listenerArn":{"type":"string"},"port":{"type":"number"},"protocol":{"type":"string"},"loadBalancerArn":{"type":"string"},"sslPolicy":{"type":"string"},"certificates":{"type":"array","items":{"type":"object","properties":{"certificateArn":{"type":"string"},"isDefault":{"type":"boolean"}},"required":["certificateArn","isDefault"],"additionalProperties":false}}},"required":["listenerArn","port","protocol","loadBalancerArn"],"additionalProperties":false}}},"required":["listeners"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/aws-elastic-load-balancer/{pkiSyncId}/certificates/default":{"post":{"description":"Set a certificate as the default for all listeners in this AWS ELB PKI Sync. This will trigger a sync immediately.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"certificateId":{"type":"string","format":"uuid"}},"required":["certificateId"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"description":"Clear the default certificate for this AWS ELB PKI Sync. No certificate will be set as the default on listeners. This will trigger a sync immediately.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/chef":{"get":{"tags":["PKI Syncs"],"description":"List the Chef PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["chef"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Create a Chef PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["chef"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/chef/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get the specified Chef PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["chef"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Syncs"],"description":"Update the specified Chef PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["chef"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Delete the specified Chef PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["chef"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"dataBagName":{"type":"string","minLength":1,"maxLength":255}},"required":["dataBagName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","default":false},"updateExistingCertificates":{"type":"boolean","default":true},"certificateNameSchema":{"type":"string","minLength":1},"fieldMappings":{"type":"object","properties":{"certificate":{"type":"string","minLength":1,"default":"certificate"},"privateKey":{"type":"string","minLength":1,"default":"private_key"},"certificateChain":{"type":"string","minLength":1,"default":"certificate_chain"},"caCertificate":{"type":"string","minLength":1,"default":"ca_certificate"}},"additionalProperties":false,"default":{"certificate":"certificate","privateKey":"private_key","certificateChain":"certificate_chain","caCertificate":"ca_certificate"}}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/chef/{pkiSyncId}/sync":{"post":{"tags":["PKI Syncs"],"description":"Trigger a sync for the specified Chef PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/chef/{pkiSyncId}/remove-certificates":{"post":{"tags":["PKI Syncs"],"description":"Remove certificates from the specified Chef PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/gcp-certificate-manager":{"get":{"tags":["PKI Syncs"],"description":"List the GCP Certificate Manager PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["gcp-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"],"default":"default"}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Create a GCP Certificate Manager PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"],"default":"default"}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["gcp-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"],"default":"default"}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/gcp-certificate-manager/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get the specified GCP Certificate Manager PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["gcp-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"],"default":"default"}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Syncs"],"description":"Update the specified GCP Certificate Manager PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"]}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string","format":"uuid"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["gcp-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"],"default":"default"}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Delete the specified GCP Certificate Manager PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["gcp-certificate-manager"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"gcpProjectId":{"type":"string","minLength":6,"maxLength":30},"location":{"type":"string","minLength":1},"certificateMapBinding":{"type":"object","properties":{"certificateMap":{"type":"string","minLength":1,"maxLength":63},"hostname":{"type":"string","maxLength":253}},"required":["certificateMap"],"additionalProperties":false},"scope":{"type":"string","enum":["default","edge-cache","all-regions","client-auth"],"default":"default"}},"required":["gcpProjectId","location"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"labels":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":63},"value":{"type":"string","maxLength":63}},"required":["key","value"],"additionalProperties":false},"maxItems":62},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/gcp-certificate-manager/{pkiSyncId}/sync":{"post":{"tags":["PKI Syncs"],"description":"Trigger a sync for the specified GCP Certificate Manager PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/gcp-certificate-manager/{pkiSyncId}/remove-certificates":{"post":{"tags":["PKI Syncs"],"description":"Remove certificates from the specified GCP Certificate Manager PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/cloudflare-custom-certificate":{"get":{"tags":["PKI Syncs"],"description":"List the Cloudflare Custom SSL Certificate PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["cloudflare-custom-certificate"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Create a Cloudflare Custom SSL Certificate PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["cloudflare-custom-certificate"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/cloudflare-custom-certificate/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get the specified Cloudflare Custom SSL Certificate PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["cloudflare-custom-certificate"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Syncs"],"description":"Update the specified Cloudflare Custom SSL Certificate PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["cloudflare-custom-certificate"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Delete the specified Cloudflare Custom SSL Certificate PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["cloudflare-custom-certificate"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"zoneId":{"type":"string","minLength":1}},"required":["zoneId"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/cloudflare-custom-certificate/{pkiSyncId}/sync":{"post":{"tags":["PKI Syncs"],"description":"Trigger a sync for the specified Cloudflare Custom SSL Certificate PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/cloudflare-custom-certificate/{pkiSyncId}/remove-certificates":{"post":{"tags":["PKI Syncs"],"description":"Remove certificates from the specified Cloudflare Custom SSL Certificate PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/netscaler":{"get":{"tags":["PKI Syncs"],"description":"List the NetScaler PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["netscaler"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Create a NetScaler PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["netscaler"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/netscaler/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get the specified NetScaler PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["netscaler"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Syncs"],"description":"Update the specified NetScaler PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["netscaler"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Delete the specified NetScaler PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["netscaler"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"vserverName":{"type":"string","maxLength":127}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/netscaler/{pkiSyncId}/sync":{"post":{"tags":["PKI Syncs"],"description":"Trigger a sync for the specified NetScaler PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/netscaler/{pkiSyncId}/remove-certificates":{"post":{"tags":["PKI Syncs"],"description":"Remove certificates from the specified NetScaler PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/f5-big-ip":{"get":{"tags":["PKI Syncs"],"description":"List the F5 BIG-IP PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["f5-big-ip"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Create a F5 BIG-IP PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["f5-big-ip"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/f5-big-ip/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get the specified F5 BIG-IP PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["f5-big-ip"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Syncs"],"description":"Update the specified F5 BIG-IP PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["f5-big-ip"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Delete the specified F5 BIG-IP PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["f5-big-ip"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"partition":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"profileType":{"type":"string","enum":["none","client-ssl","server-ssl"]},"profileName":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[a-zA-Z0-9._-]{1,255}$"},"createProfileIfMissing":{"type":"boolean"},"parentProfile":{"type":"string","minLength":1,"maxLength":511}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/f5-big-ip/{pkiSyncId}/sync":{"post":{"tags":["PKI Syncs"],"description":"Trigger a sync for the specified F5 BIG-IP PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/f5-big-ip/{pkiSyncId}/remove-certificates":{"post":{"tags":["PKI Syncs"],"description":"Remove certificates from the specified F5 BIG-IP PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/kemp-loadmaster":{"get":{"tags":["PKI Syncs"],"description":"List the Kemp LoadMaster PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["kemp-loadmaster"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Create a Kemp LoadMaster PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["kemp-loadmaster"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/kemp-loadmaster/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get the specified Kemp LoadMaster PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["kemp-loadmaster"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Syncs"],"description":"Update the specified Kemp LoadMaster PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["kemp-loadmaster"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Delete the specified Kemp LoadMaster PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["kemp-loadmaster"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"virtualServiceId":{"type":"string","maxLength":10}},"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":true},"includeRootCa":{"type":"boolean","default":false},"preserveItemOnRenewal":{"type":"boolean","default":true},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"caCertificateNameSchema":{"type":"string","default":"Infisical-ca-{{fingerprint}}"},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/kemp-loadmaster/{pkiSyncId}/sync":{"post":{"tags":["PKI Syncs"],"description":"Trigger a sync for the specified Kemp LoadMaster PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/kemp-loadmaster/{pkiSyncId}/remove-certificates":{"post":{"tags":["PKI Syncs"],"description":"Remove certificates from the specified Kemp LoadMaster PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/kemp-loadmaster/virtual-services":{"get":{"description":"List the Virtual Services available on the Kemp LoadMaster for the specified connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"query","name":"connectionId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"virtualServices":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"address":{"type":"string"},"port":{"type":"number"},"protocol":{"type":"string"}},"required":["id","name","address","port","protocol"],"additionalProperties":false}}},"required":["virtualServices"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/linux-server":{"get":{"tags":["PKI Syncs"],"description":"List the Linux Server PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["linux-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Create a Linux Server PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"credentials":{"type":"object","properties":{"exportPassword":{"type":"string","minLength":1,"maxLength":1024}},"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["linux-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/linux-server/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get the specified Linux Server PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["linux-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Syncs"],"description":"Update the specified Linux Server PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"credentials":{"type":"object","properties":{"exportPassword":{"type":"string","minLength":1,"maxLength":1024}},"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["linux-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Delete the specified Linux Server PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["linux-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/linux-server/test-health-check":{"post":{"tags":["PKI Syncs"],"description":"Run a health check command against a Linux Server host without saving it to a sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"syncId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":100},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sshHostKeys":{"type":"string","maxLength":8192,"description":"Trusted SSH host keys for the target, as produced by 'ssh-keyscan <host>'. When set, the sync refuses to authenticate if the host presents a different key."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pem"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileMode":{"type":"string"},"privateKeyFileMode":{"type":"string"},"owner":{"type":"string","maxLength":32},"group":{"type":"string","maxLength":32},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"additionalProperties":false}},"required":["connectionId","destinationConfig","syncOptions"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"healthCheck":{"type":"object","properties":{"status":{"type":"string","enum":["pending","running","succeeded","failed"]},"exitCode":{"type":"number"},"timedOut":{"type":"boolean"},"durationMs":{"type":"number"},"output":{"type":"string"},"failureDetail":{"type":"string"},"message":{"type":"string"}},"required":["status","durationMs"],"additionalProperties":false}},"required":["healthCheck"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/linux-server/{pkiSyncId}/run-health-check":{"post":{"tags":["PKI Syncs"],"description":"Run the configured health check for the specified Linux Server PKI Sync without delivering certificates.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"healthCheck":{"type":"object","properties":{"status":{"type":"string","enum":["pending","running","succeeded","failed"]},"exitCode":{"type":"number"},"timedOut":{"type":"boolean"},"durationMs":{"type":"number"},"output":{"type":"string"},"failureDetail":{"type":"string"},"message":{"type":"string"}},"required":["status","durationMs"],"additionalProperties":false}},"required":["healthCheck"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/linux-server/{pkiSyncId}/sync":{"post":{"tags":["PKI Syncs"],"description":"Trigger a sync for the specified Linux Server PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/linux-server/{pkiSyncId}/remove-certificates":{"post":{"tags":["PKI Syncs"],"description":"Remove certificates from the specified Linux Server PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/windows-server":{"get":{"tags":["PKI Syncs"],"description":"List the Windows Server PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["windows-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Create a Windows Server PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"credentials":{"type":"object","properties":{"exportPassword":{"type":"string","minLength":1,"maxLength":1024}},"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","syncOptions","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["windows-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/windows-server/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get the specified Windows Server PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["windows-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Syncs"],"description":"Update the specified Windows Server PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"credentials":{"type":"object","properties":{"exportPassword":{"type":"string","minLength":1,"maxLength":1024}},"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["windows-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Delete the specified Windows Server PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["windows-server"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"required":["certificateNameSchema"],"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/windows-server/test-health-check":{"post":{"tags":["PKI Syncs"],"description":"Run a health check command against a Windows Server host without saving it to a sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"connectionId":{"type":"string","format":"uuid"},"applicationId":{"type":"string","format":"uuid"},"syncId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":100},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."},"destinationConfig":{"type":"object","properties":{"destinationPath":{"type":"string","minLength":1,"maxLength":4096},"host":{"type":"string","minLength":1,"maxLength":253},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The port to reach the target host on. Defaults to the protocol's standard port."},"sslEnabled":{"type":"boolean","description":"Reach the host over HTTPS WinRM instead of HTTP with NTLM message encryption."},"sslRejectUnauthorized":{"type":"boolean","description":"Verify the host's WinRM certificate when using HTTPS."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["destinationPath"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canRemoveCertificates":{"type":"boolean","default":false},"includeRootCa":{"type":"boolean","default":false},"includePrivateKey":{"type":"boolean","default":true},"exportFormat":{"type":"string","enum":["pem","pkcs12","jks"],"default":"pkcs12"},"pemCertificateExtension":{"type":"string","enum":["pem","crt"],"default":"pem"},"combineCertificateChain":{"type":"boolean","default":false},"keystoreAlias":{"type":"string","minLength":1,"maxLength":128,"description":"Alias of the private key entry in a PKCS#12 or JKS keystore. Defaults to the certificate's file base name. JKS stores aliases in lowercase."},"includeTruststore":{"type":"boolean","description":"Java KeyStore only: also deliver '<name>.truststore.jks' holding the chain and root CA as trusted certificates."},"fileAccessRules":{"type":"array","items":{"type":"object","properties":{"identity":{"type":"string","minLength":1,"maxLength":256},"access":{"type":"string","enum":["read","modify","full-control"]}},"required":["identity","access"],"additionalProperties":false},"maxItems":20},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true},"certificateNameSchema":{"type":"string","minLength":1}},"additionalProperties":false}},"required":["connectionId","destinationConfig","syncOptions"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"healthCheck":{"type":"object","properties":{"status":{"type":"string","enum":["pending","running","succeeded","failed"]},"exitCode":{"type":"number"},"timedOut":{"type":"boolean"},"durationMs":{"type":"number"},"output":{"type":"string"},"failureDetail":{"type":"string"},"message":{"type":"string"}},"required":["status","durationMs"],"additionalProperties":false}},"required":["healthCheck"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/windows-server/{pkiSyncId}/run-health-check":{"post":{"tags":["PKI Syncs"],"description":"Run the configured health check for the specified Windows Server PKI Sync without delivering certificates.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"healthCheck":{"type":"object","properties":{"status":{"type":"string","enum":["pending","running","succeeded","failed"]},"exitCode":{"type":"number"},"timedOut":{"type":"boolean"},"durationMs":{"type":"number"},"output":{"type":"string"},"failureDetail":{"type":"string"},"message":{"type":"string"}},"required":["status","durationMs"],"additionalProperties":false}},"required":["healthCheck"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/windows-server/{pkiSyncId}/sync":{"post":{"tags":["PKI Syncs"],"description":"Trigger a sync for the specified Windows Server PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/windows-server/{pkiSyncId}/remove-certificates":{"post":{"tags":["PKI Syncs"],"description":"Remove certificates from the specified Windows Server PKI Sync destination.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/nutanix-prism-central":{"get":{"tags":["PKI Syncs"],"description":"List the Nutanix Prism Central PKI Syncs for the specified project.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"pkiSyncs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}},"required":["pkiSyncs"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"tags":["PKI Syncs"],"description":"Create a Nutanix Prism Central PKI Sync for the specified project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean","default":true},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false,"default":{"canImportCertificates":false,"canRemoveCertificates":false}},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"applicationId":{"type":"string","format":"uuid"},"certificateIds":{"type":"array","items":{"type":"string","format":"uuid"}},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["name","destinationConfig","connectionId"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/nutanix-prism-central/{pkiSyncId}":{"get":{"tags":["PKI Syncs"],"description":"Get the specified Nutanix Prism Central PKI Sync by ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"tags":["PKI Syncs"],"description":"Update the specified Nutanix Prism Central PKI Sync.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":256},"description":{"type":"string","maxLength":255},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"subscriberId":{"type":"string","nullable":true},"connectionId":{"type":"string"},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":20,"description":"Match certificates issued from any one of these certificate profiles."},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":10000,"description":"Match any certificate belonging to any one of these certificate orders. An order groups a certificate with every renewal of it, so this keeps matching as the certificate is renewed."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":255,"description":"Metadata key the certificate must carry."},"value":{"type":"string","maxLength":1020,"description":"Metadata value the key must have. Omit it to match any value."}},"required":["key"],"additionalProperties":false},"maxItems":20,"description":"Match certificates carrying every one of these metadata pairs. Give a key on its own to match any value for that key."}},"additionalProperties":false,"nullable":true,"description":"Replaces which of the Application's certificates this sync holds. Omit to leave them unchanged, or set to null to empty the sync."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"tags":["PKI Syncs"],"description":"Delete the specified Nutanix Prism Central PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","maxLength":256},"description":{"type":"string","nullable":true},"destination":{"type":"string","enum":["nutanix-prism-central"]},"isAutoSyncEnabled":{"type":"boolean"},"destinationConfig":{"type":"object","properties":{"clusterId":{"type":"string","minLength":1},"clusterName":{"type":"string","minLength":1}},"required":["clusterId","clusterName"],"additionalProperties":false},"syncOptions":{"type":"object","properties":{"canImportCertificates":{"type":"boolean","enum":[false],"default":false},"canRemoveCertificates":{"type":"boolean","enum":[false],"default":false},"healthCheckCommand":{"type":"string","maxLength":8192,"nullable":true},"postSyncCommand":{"type":"string","maxLength":8192,"nullable":true}},"additionalProperties":false},"projectId":{"type":"string","format":"uuid"},"subscriberId":{"type":"string","format":"uuid","nullable":true},"connectionId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"syncStatus":{"type":"string","nullable":true},"lastSyncedAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckRanAt":{"type":"string","format":"date-time","nullable":true},"lastHealthCheckStatus":{"type":"string","enum":["pending","running","succeeded","failed"],"nullable":true},"lastHealthCheckMessage":{"type":"string","nullable":true},"filters":{"type":"object","properties":{"profileIds":{"type":"array","items":{"type":"string","format":"uuid"}},"certificateOrderIds":{"type":"array","items":{"type":"string","format":"uuid"}},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key"],"additionalProperties":false}}},"additionalProperties":false,"nullable":true,"description":"Which of the Application's certificates this sync holds. A certificate must match every field that is set, and a sync with no filters holds nothing."}},"required":["id","name","destination","isAutoSyncEnabled","destinationConfig","syncOptions","projectId","connectionId","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/pki/syncs/nutanix-prism-central/{pkiSyncId}/sync":{"post":{"tags":["PKI Syncs"],"description":"Trigger a sync for the specified Nutanix Prism Central PKI Sync.","parameters":[{"schema":{"type":"string"},"in":"path","name":"pkiSyncId","required":true}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/integration":{"post":{"operationId":"createIntegration","tags":["Integrations"],"description":"Create an integration to sync secrets. Deprecated: use Secret Syncs instead.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"integrationAuthId":{"type":"string","description":"The ID of the integration auth object to link with integration."},"app":{"type":"string","description":"The name of the external integration providers app entity that you want to sync secrets with. Used in Netlify, GitHub, Vercel integrations."},"isActive":{"type":"boolean","description":"Whether the integration should be active or disabled.","default":true},"appId":{"type":"string","description":"The ID of the external integration providers app entity that you want to sync secrets with. Used in Netlify, GitHub, Vercel integrations."},"secretPath":{"type":"string","default":"/","description":"The path of the secrets to sync secrets from."},"sourceEnvironment":{"type":"string","description":"The environment to sync secret from."},"targetEnvironment":{"type":"string","description":"The target environment of the integration provider. Used in cloudflare pages, TeamCity, Gitlab integrations."},"targetEnvironmentId":{"type":"string","description":"The target environment ID of the integration provider. Used in cloudflare pages, teamcity, gitlab integrations."},"targetService":{"type":"string","description":"The service based grouping identifier of the external provider. Used in Terraform cloud, Checkly, Railway and NorthFlank."},"targetServiceId":{"type":"string","description":"The service based grouping identifier ID of the external provider. Used in Terraform cloud, Checkly, Railway and NorthFlank."},"owner":{"type":"string","description":"External integration providers service entity owner. Used in Github."},"url":{"type":"string","format":"uri","description":"The self-hosted URL of the platform to integrate with."},"path":{"type":"string","description":"Path to save the synced secrets. Used by Gitlab, AWS Parameter Store, Vault."},"region":{"type":"string","description":"AWS region to sync secrets to."},"scope":{"type":"string","description":"Scope of the provider. Used by Github, Qovery."},"metadata":{"type":"object","properties":{"initialSyncBehavior":{"type":"string","description":"Type of syncing behavoir with the integration."},"secretPrefix":{"type":"string","description":"The prefix for the saved secret. Used by GCP."},"secretSuffix":{"type":"string","description":"The suffix for the saved secret. Used by GCP."},"mappingBehavior":{"type":"string","enum":["one-to-one","many-to-one"],"description":"The mapping behavior of the integration."},"shouldAutoRedeploy":{"type":"boolean","description":"Used by Render to trigger auto deploy."},"secretGCPLabel":{"type":"object","properties":{"labelName":{"type":"string"},"labelValue":{"type":"string"}},"required":["labelName","labelValue"],"additionalProperties":false,"description":"The label for GCP secrets."},"secretAWSTag":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"description":"The tags for AWS secrets."},"azureLabel":{"type":"string","description":"Define which label to assign to secrets created in Azure App Configuration."},"githubVisibility":{"anyOf":[{"type":"string","enum":["selected"]},{"type":"string","enum":["private"]},{"type":"string","enum":["all"]}],"description":"Define where the secrets from the Github Integration should be visible. Option 'selected' lets you directly define which repositories to sync secrets to."},"githubVisibilityRepoIds":{"type":"array","items":{"type":"string"},"description":"The repository IDs to sync secrets to when using the Github Integration. Only applicable when using Organization scope, and visibility is set to 'selected'."},"kmsKeyId":{"type":"string","description":"The ID of the encryption key from AWS KMS."},"shouldDisableDelete":{"type":"boolean","description":"The flag to disable deletion of secrets in AWS Parameter Store."},"shouldEnableDelete":{"type":"boolean","description":"The flag to enable deletion of secrets."},"shouldMaskSecrets":{"type":"boolean","description":"Specifies if the secrets synced from Infisical to Gitlab should be marked as 'Masked'."},"shouldProtectSecrets":{"type":"boolean","description":"Specifies if the secrets synced from Infisical to Gitlab should be marked as 'Protected'."},"metadataSyncMode":{"type":"string","enum":["custom","secret-metadata"],"description":"The mode for syncing metadata to external system"},"octopusDeployScopeValues":{"type":"object","properties":{"Environment":{"type":"array","items":{"type":"string"}},"Action":{"type":"array","items":{"type":"string"}},"Channel":{"type":"array","items":{"type":"string"}},"Machine":{"type":"array","items":{"type":"string"}},"ProcessOwner":{"type":"array","items":{"type":"string"}},"Role":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"description":"Specifies the scope values to set on synced secrets to Octopus Deploy."}},"additionalProperties":false,"default":{}}},"required":["integrationAuthId","sourceEnvironment"],"additionalProperties":false}}}},"deprecated":true,"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"integration":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"isActive":{"type":"boolean"},"url":{"type":"string","nullable":true},"app":{"type":"string","nullable":true},"appId":{"type":"string","nullable":true},"targetEnvironment":{"type":"string","nullable":true},"targetEnvironmentId":{"type":"string","nullable":true},"targetService":{"type":"string","nullable":true},"targetServiceId":{"type":"string","nullable":true},"owner":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"scope":{"type":"string","nullable":true},"integration":{"type":"string"},"metadata":{"nullable":true},"integrationAuthId":{"type":"string","format":"uuid"},"envId":{"type":"string","format":"uuid"},"secretPath":{"type":"string","default":"/"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastUsed":{"type":"string","format":"date-time","nullable":true},"isSynced":{"type":"boolean","nullable":true},"syncMessage":{"type":"string","nullable":true},"lastSyncJobId":{"type":"string","nullable":true},"environment":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"}},"required":["slug","name","id"],"additionalProperties":false}},"required":["id","isActive","integration","integrationAuthId","envId","createdAt","updatedAt","environment"],"additionalProperties":false}},"required":["integration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/integration/{integrationId}":{"patch":{"operationId":"updateIntegration","tags":["Integrations"],"description":"Update an integration by integration id","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"app":{"type":"string","description":"The name of the external integration providers app entity that you want to sync secrets with. Used in Netlify, GitHub, Vercel integrations."},"appId":{"type":"string","description":"The ID of the external integration providers app entity that you want to sync secrets with. Used in Netlify, GitHub, Vercel integrations."},"isActive":{"type":"boolean","description":"Whether the integration should be active or disabled."},"secretPath":{"type":"string","default":"/","description":"The path of the secrets to sync secrets from."},"targetEnvironment":{"type":"string","description":"The target environment of the integration provider. Used in cloudflare pages, TeamCity, Gitlab integrations."},"owner":{"type":"string","description":"External integration providers service entity owner. Used in Github."},"environment":{"type":"string","description":"The environment to sync secrets from."},"path":{"type":"string","description":"Path to save the synced secrets. Used by Gitlab, AWS Parameter Store, Vault."},"metadata":{"type":"object","properties":{"initialSyncBehavior":{"type":"string","description":"Type of syncing behavoir with the integration."},"secretPrefix":{"type":"string","description":"The prefix for the saved secret. Used by GCP."},"secretSuffix":{"type":"string","description":"The suffix for the saved secret. Used by GCP."},"mappingBehavior":{"type":"string","enum":["one-to-one","many-to-one"],"description":"The mapping behavior of the integration."},"shouldAutoRedeploy":{"type":"boolean","description":"Used by Render to trigger auto deploy."},"secretGCPLabel":{"type":"object","properties":{"labelName":{"type":"string"},"labelValue":{"type":"string"}},"required":["labelName","labelValue"],"additionalProperties":false,"description":"The label for GCP secrets."},"secretAWSTag":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"description":"The tags for AWS secrets."},"azureLabel":{"type":"string","description":"Define which label to assign to secrets created in Azure App Configuration."},"githubVisibility":{"anyOf":[{"type":"string","enum":["selected"]},{"type":"string","enum":["private"]},{"type":"string","enum":["all"]}],"description":"Define where the secrets from the Github Integration should be visible. Option 'selected' lets you directly define which repositories to sync secrets to."},"githubVisibilityRepoIds":{"type":"array","items":{"type":"string"},"description":"The repository IDs to sync secrets to when using the Github Integration. Only applicable when using Organization scope, and visibility is set to 'selected'."},"kmsKeyId":{"type":"string","description":"The ID of the encryption key from AWS KMS."},"shouldDisableDelete":{"type":"boolean","description":"The flag to disable deletion of secrets in AWS Parameter Store."},"shouldEnableDelete":{"type":"boolean","description":"The flag to enable deletion of secrets."},"shouldMaskSecrets":{"type":"boolean","description":"Specifies if the secrets synced from Infisical to Gitlab should be marked as 'Masked'."},"shouldProtectSecrets":{"type":"boolean","description":"Specifies if the secrets synced from Infisical to Gitlab should be marked as 'Protected'."},"metadataSyncMode":{"type":"string","enum":["custom","secret-metadata"],"description":"The mode for syncing metadata to external system"},"octopusDeployScopeValues":{"type":"object","properties":{"Environment":{"type":"array","items":{"type":"string"}},"Action":{"type":"array","items":{"type":"string"}},"Channel":{"type":"array","items":{"type":"string"}},"Machine":{"type":"array","items":{"type":"string"}},"ProcessOwner":{"type":"array","items":{"type":"string"}},"Role":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"description":"Specifies the scope values to set on synced secrets to Octopus Deploy."}},"additionalProperties":false},"region":{"type":"string","description":"AWS region to sync secrets to."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"integrationId","required":true,"description":"The ID of the integration object."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"integration":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"isActive":{"type":"boolean"},"url":{"type":"string","nullable":true},"app":{"type":"string","nullable":true},"appId":{"type":"string","nullable":true},"targetEnvironment":{"type":"string","nullable":true},"targetEnvironmentId":{"type":"string","nullable":true},"targetService":{"type":"string","nullable":true},"targetServiceId":{"type":"string","nullable":true},"owner":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"scope":{"type":"string","nullable":true},"integration":{"type":"string"},"metadata":{"nullable":true},"integrationAuthId":{"type":"string","format":"uuid"},"envId":{"type":"string","format":"uuid"},"secretPath":{"type":"string","default":"/"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastUsed":{"type":"string","format":"date-time","nullable":true},"isSynced":{"type":"boolean","nullable":true},"syncMessage":{"type":"string","nullable":true},"lastSyncJobId":{"type":"string","nullable":true},"environment":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"}},"required":["slug","name","id"],"additionalProperties":false}},"required":["id","isActive","integration","integrationAuthId","envId","createdAt","updatedAt","environment"],"additionalProperties":false}},"required":["integration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getIntegration","tags":["Integrations"],"description":"Get an integration by integration id","parameters":[{"schema":{"type":"string"},"in":"path","name":"integrationId","required":true,"description":"The ID of the integration object."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"integration":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"isActive":{"type":"boolean"},"url":{"type":"string","nullable":true},"app":{"type":"string","nullable":true},"appId":{"type":"string","nullable":true},"targetEnvironment":{"type":"string","nullable":true},"targetEnvironmentId":{"type":"string","nullable":true},"targetService":{"type":"string","nullable":true},"targetServiceId":{"type":"string","nullable":true},"owner":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"scope":{"type":"string","nullable":true},"integration":{"type":"string"},"metadata":{"nullable":true},"integrationAuthId":{"type":"string","format":"uuid"},"envId":{"type":"string","format":"uuid"},"secretPath":{"type":"string","default":"/"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastUsed":{"type":"string","format":"date-time","nullable":true},"isSynced":{"type":"boolean","nullable":true},"syncMessage":{"type":"string","nullable":true},"lastSyncJobId":{"type":"string","nullable":true},"environment":{"type":"object","properties":{"slug":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"}},"required":["slug","name","id"],"additionalProperties":false}},"required":["id","isActive","integration","integrationAuthId","envId","createdAt","updatedAt","environment"],"additionalProperties":false}},"required":["integration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteIntegration","tags":["Integrations"],"description":"Remove an integration using the integration object ID","parameters":[{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"shouldDeleteIntegrationSecrets","required":false},{"schema":{"type":"string"},"in":"path","name":"integrationId","required":true,"description":"The ID of the integration object."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"integration":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"isActive":{"type":"boolean"},"url":{"type":"string","nullable":true},"app":{"type":"string","nullable":true},"appId":{"type":"string","nullable":true},"targetEnvironment":{"type":"string","nullable":true},"targetEnvironmentId":{"type":"string","nullable":true},"targetService":{"type":"string","nullable":true},"targetServiceId":{"type":"string","nullable":true},"owner":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"scope":{"type":"string","nullable":true},"integration":{"type":"string"},"metadata":{"nullable":true},"integrationAuthId":{"type":"string","format":"uuid"},"envId":{"type":"string","format":"uuid"},"secretPath":{"type":"string","default":"/"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastUsed":{"type":"string","format":"date-time","nullable":true},"isSynced":{"type":"boolean","nullable":true},"syncMessage":{"type":"string","nullable":true},"lastSyncJobId":{"type":"string","nullable":true}},"required":["id","isActive","integration","integrationAuthId","envId","createdAt","updatedAt"],"additionalProperties":false}},"required":["integration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/integration/{integrationId}/sync":{"post":{"operationId":"syncIntegration","tags":["Integrations"],"description":"Manually trigger sync of an integration by integration id","parameters":[{"schema":{"type":"string"},"in":"path","name":"integrationId","required":true,"description":"The ID of the integration object to manually sync."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"integration":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"isActive":{"type":"boolean"},"url":{"type":"string","nullable":true},"app":{"type":"string","nullable":true},"appId":{"type":"string","nullable":true},"targetEnvironment":{"type":"string","nullable":true},"targetEnvironmentId":{"type":"string","nullable":true},"targetService":{"type":"string","nullable":true},"targetServiceId":{"type":"string","nullable":true},"owner":{"type":"string","nullable":true},"path":{"type":"string","nullable":true},"region":{"type":"string","nullable":true},"scope":{"type":"string","nullable":true},"integration":{"type":"string"},"metadata":{"nullable":true},"integrationAuthId":{"type":"string","format":"uuid"},"envId":{"type":"string","format":"uuid"},"secretPath":{"type":"string","default":"/"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastUsed":{"type":"string","format":"date-time","nullable":true},"isSynced":{"type":"boolean","nullable":true},"syncMessage":{"type":"string","nullable":true},"lastSyncJobId":{"type":"string","nullable":true}},"required":["id","isActive","integration","integrationAuthId","envId","createdAt","updatedAt"],"additionalProperties":false}},"required":["integration"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/integration-auth/integration-options":{"get":{"tags":["Integrations"],"description":"List of integrations available.","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"integrationOptions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"syncSlug":{"type":"string"},"clientSlug":{"type":"string"},"image":{"type":"string"},"isAvailable":{"type":"boolean"},"type":{"type":"string"},"clientId":{"type":"string"},"docsLink":{"type":"string"}},"required":["name","slug","image","type"],"additionalProperties":false}}},"required":["integrationOptions"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/integration-auth/{integrationAuthId}":{"get":{"operationId":"getIntegrationAuth","tags":["Integrations"],"description":"Get details of an integration authorization by auth object id.","parameters":[{"schema":{"type":"string"},"in":"path","name":"integrationAuthId","required":true,"description":"The ID of integration authentication object."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"integrationAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"integration":{"type":"string"},"teamId":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"namespace":{"type":"string","nullable":true},"accountId":{"type":"string","nullable":true},"metadata":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","integration","createdAt","updatedAt"],"additionalProperties":false}},"required":["integrationAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateIntegrationAuth","tags":["Integrations"],"description":"Update the integration authentication object required for syncing secrets.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"integration":{"type":"string","enum":["azure-key-vault","aws-parameter-store","aws-secret-manager","gcp-secret-manager","heroku","vercel","netlify","github","gitlab","render","railway","flyio","laravel-forge","circleci","databricks","travisci","teamcity","supabase","checkly","qovery","terraform-cloud","hashicorp-vault","cloudflare-pages","cloudflare-workers","bitbucket","codefresh","windmill","digital-ocean-app-platform","cloud-66","northflank","hasura-cloud","rundeck","azure-devops","azure-app-configuration","octopus-deploy"],"description":"The slug of integration for the auth object."},"accessId":{"type":"string","description":"The unique authorized access ID of the external integration provider."},"accessToken":{"type":"string","description":"The unique authorized access token of the external integration provider."},"awsAssumeIamRoleArn":{"type":"string","format":"uri","description":"The AWS IAM Role to be assumed by Infisical."},"url":{"type":"string","format":"uri"},"namespace":{"type":"string"},"refreshToken":{"type":"string","description":"The refresh token for integration authorization."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"integrationAuthId","required":true,"description":"The ID of integration authentication object to update."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"integrationAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"integration":{"type":"string"},"teamId":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"namespace":{"type":"string","nullable":true},"accountId":{"type":"string","nullable":true},"metadata":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","integration","createdAt","updatedAt"],"additionalProperties":false}},"required":["integrationAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteIntegrationAuth","tags":["Integrations"],"description":"Remove an integration auth object by object id.","parameters":[{"schema":{"type":"string"},"in":"path","name":"integrationAuthId","required":true,"description":"The ID of integration authentication object to delete."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"integrationAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"integration":{"type":"string"},"teamId":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"namespace":{"type":"string","nullable":true},"accountId":{"type":"string","nullable":true},"metadata":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","integration","createdAt","updatedAt"],"additionalProperties":false}},"required":["integrationAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/integration-auth":{"delete":{"operationId":"deleteIntegrationAuths","tags":["Integrations"],"description":"Remove all integration's auth object from the project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"integration","required":true,"description":"The slug of the integration to be unauthorized."},{"schema":{"type":"string"},"in":"query","name":"projectId","required":true,"description":"The ID of the project to delete the integration auth from."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"integrationAuth":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"integration":{"type":"string"},"teamId":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"namespace":{"type":"string","nullable":true},"accountId":{"type":"string","nullable":true},"metadata":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","integration","createdAt","updatedAt"],"additionalProperties":false}}},"required":["integrationAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/integration-auth/access-token":{"post":{"operationId":"createIntegrationAuth","tags":["Integrations"],"description":"Create the integration authentication object required for syncing secrets.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"workspaceId":{"type":"string","description":"The ID of the project to create the integration auth for."},"integration":{"type":"string","description":"The slug of integration for the auth object."},"accessId":{"type":"string","description":"The unique authorized access ID of the external integration provider."},"accessToken":{"type":"string","description":"The unique authorized access token of the external integration provider."},"awsAssumeIamRoleArn":{"type":"string","format":"uri","description":"The AWS IAM Role to be assumed by Infisical."},"url":{"type":"string","format":"uri"},"namespace":{"type":"string"},"refreshToken":{"type":"string","description":"The refresh token for integration authorization."}},"required":["workspaceId","integration"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"integrationAuth":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"projectId":{"type":"string"},"integration":{"type":"string"},"teamId":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"namespace":{"type":"string","nullable":true},"accountId":{"type":"string","nullable":true},"metadata":{"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","projectId","integration","createdAt","updatedAt"],"additionalProperties":false}},"required":["integrationAuth"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/identities":{"post":{"operationId":"createMachineIdentity","tags":["Identities"],"description":"Create machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the identity to create."},"organizationId":{"type":"string","description":"The organization ID to which the identity belongs."},"role":{"type":"string","minLength":1,"default":"no-access","description":"The role of the identity. Possible values are 'no-access', 'member', and 'admin'."},"hasDeleteProtection":{"type":"boolean","default":false,"description":"Prevents deletion of the identity when enabled."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["key","value"],"additionalProperties":false}}},"required":["name","organizationId"],"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"hasDeleteProtection":{"type":"boolean","default":false},"orgId":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"authMethods":{"type":"array","items":{"type":"string"}},"metadata":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"}},"required":["id","key","value"],"additionalProperties":false}}},"required":["id","name","createdAt","updatedAt","orgId","authMethods","metadata"],"additionalProperties":false}},"required":["identity"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listMachineIdentities","tags":["Identities"],"description":"List machine identities","parameters":[{"schema":{"type":"string"},"in":"query","name":"orgId","required":true,"description":"The ID of the organization to list identities."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string"},"roleId":{"type":"string","format":"uuid","nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"lastLoginAuthMethod":{"type":"string","nullable":true},"lastLoginTime":{"type":"string","format":"date-time","nullable":true},"customRole":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"permissions":{},"description":{"type":"string","nullable":true}},"required":["id","name","slug"],"additionalProperties":false},"identity":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"hasDeleteProtection":{"type":"boolean","default":false},"authMethods":{"type":"array","items":{"type":"string"}}},"required":["name","id","authMethods"],"additionalProperties":false}},"required":["id","role","orgId","createdAt","updatedAt","identityId","identity"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["identities","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/identities/{identityId}":{"patch":{"operationId":"updateMachineIdentity","tags":["Identities"],"description":"Update machine identity","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the identity."},"role":{"type":"string","minLength":1,"description":"The new role of the identity."},"hasDeleteProtection":{"type":"boolean","description":"Prevents deletion of the identity when enabled."},"metadata":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["key","value"],"additionalProperties":false}}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to update."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"hasDeleteProtection":{"type":"boolean","default":false},"orgId":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"metadata":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"}},"required":["id","key","value"],"additionalProperties":false}}},"required":["id","name","createdAt","updatedAt","orgId","metadata"],"additionalProperties":false}},"required":["identity"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteMachineIdentity","tags":["Identities"],"description":"Delete machine identity","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to delete."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"authMethod":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"hasDeleteProtection":{"type":"boolean","default":false},"orgId":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true}},"required":["id","name","createdAt","updatedAt","orgId"],"additionalProperties":false}},"required":["identity"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getMachineIdentityById","tags":["Identities"],"description":"Get a machine identity by id","parameters":[{"schema":{"type":"string"},"in":"path","name":"identityId","required":true,"description":"The ID of the machine identity to get details."}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identity":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string"},"roleId":{"type":"string","format":"uuid","nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"lastLoginAuthMethod":{"type":"string","nullable":true},"lastLoginTime":{"type":"string","format":"date-time","nullable":true},"metadata":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"key":{"type":"string","minLength":1},"value":{"type":"string","minLength":1}},"required":["id","key","value"],"additionalProperties":false}},"customRole":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"permissions":{},"description":{"type":"string","nullable":true}},"required":["id","name","slug"],"additionalProperties":false},"identity":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"hasDeleteProtection":{"type":"boolean","default":false},"orgId":{"type":"string","format":"uuid"},"authMethods":{"type":"array","items":{"type":"string"}},"activeLockoutAuthMethods":{"type":"array","items":{"type":"string"}}},"required":["name","id","orgId","authMethods","activeLockoutAuthMethods"],"additionalProperties":false}},"required":["id","role","orgId","createdAt","updatedAt","identityId","identity"],"additionalProperties":false}},"required":["identity"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/identities/search":{"post":{"operationId":"searchMachineIdentities","tags":["Identities"],"description":"Search machine identities","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orderBy":{"type":"string","enum":["name","role"],"default":"name","description":"The column to order identities by."},"orderDirection":{"type":"string","enum":["asc","desc"],"default":"asc","description":"The direction to order identities in."},"limit":{"type":"number","maximum":100,"default":50,"description":"The number of identities to return."},"offset":{"type":"number","default":0,"description":"The offset to start from. If you enter 10, it will start from the 10th identity."},"search":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","maxLength":255},{"type":"object","properties":{"$eq":{"type":"string","maxLength":255},"$contains":{"type":"string","maxLength":255},"$in":{"type":"array","items":{"type":"string","maxLength":255}}},"additionalProperties":false}],"description":"The name of the identity to filter by."},"role":{"anyOf":[{"type":"string","maxLength":255},{"type":"object","properties":{"$eq":{"type":"string","maxLength":255},"$in":{"type":"array","items":{"type":"string","maxLength":255}}},"additionalProperties":false}],"description":"The organizational role of the identity to filter by."},"$or":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","maxLength":255},{"type":"object","properties":{"$eq":{"type":"string","maxLength":255},"$contains":{"type":"string","maxLength":255},"$in":{"type":"array","items":{"type":"string","maxLength":255}}},"additionalProperties":false}],"description":"The name of the identity to filter by."},"role":{"anyOf":[{"type":"string","maxLength":255},{"type":"object","properties":{"$eq":{"type":"string","maxLength":255},"$in":{"type":"array","items":{"type":"string","maxLength":255}}},"additionalProperties":false}],"description":"The organizational role of the identity to filter by."}},"additionalProperties":false,"description":"The filters to apply to the search."},"maxItems":5}},"additionalProperties":false,"description":"The filters to apply to the search."}},"additionalProperties":false}}}},"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string"},"roleId":{"type":"string","format":"uuid","nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"identityId":{"type":"string","format":"uuid"},"lastLoginAuthMethod":{"type":"string","nullable":true},"lastLoginTime":{"type":"string","format":"date-time","nullable":true},"customRole":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"permissions":{},"description":{"type":"string","nullable":true}},"required":["id","name","slug"],"additionalProperties":false},"identity":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"hasDeleteProtection":{"type":"boolean","default":false},"orgId":{"type":"string","format":"uuid"},"authMethods":{"type":"array","items":{"type":"string"}},"activeLockoutAuthMethods":{"type":"array","items":{"type":"string"}}},"required":["name","id","orgId","authMethods","activeLockoutAuthMethods"],"additionalProperties":false}},"required":["id","role","orgId","createdAt","updatedAt","identityId","identity"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["identities","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/identities/details":{"get":{"operationId":"getMachineIdentityDetails","tags":["Identities"],"description":"Get details for the calling machine identity, including the organization it belongs to. Called with the identity's own access token.","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"identityDetails":{"type":"object","properties":{"organization":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"}},"required":["id","name","slug"],"additionalProperties":false}},"required":["organization"],"additionalProperties":false}},"required":["identityDetails"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/shared-secrets":{"get":{"operationId":"listSharedSecrets","tags":["Secret Sharing"],"description":"List all shared secrets created by the authenticated user or identity in their current organization.","parameters":[{"schema":{"type":"number","minimum":0,"maximum":100,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start listing shared secrets from. Used for pagination."},{"schema":{"type":"number","minimum":1,"maximum":100,"default":25},"in":"query","name":"limit","required":false,"description":"The maximum number of shared secrets to return. Max is 100."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"secrets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"userId":{"type":"string","format":"uuid","nullable":true},"orgId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"expiresAfterViews":{"type":"number","nullable":true},"accessType":{"type":"string","default":"anyone"},"name":{"type":"string","nullable":true},"lastViewedAt":{"type":"string","format":"date-time","nullable":true},"type":{"type":"string","default":"share"},"authorizedEmails":{"nullable":true},"identityId":{"type":"string","format":"uuid","nullable":true},"allowExternalEmails":{"type":"boolean","default":false,"nullable":true}},"required":["id","expiresAt","createdAt","updatedAt"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["secrets","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createSharedSecret","tags":["Secret Sharing"],"description":"Create a new shared secret that can be accessed by a link.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":50,"description":"An optional name for the shared secret for easier identification."},"password":{"type":"string","description":"An optional password to protect the shared secret. Recipients will need to provide this password to access the secret."},"secretValue":{"type":"string","maxLength":10000,"description":"The secret value to share."},"expiresIn":{"type":"string","default":"30d","description":"The duration after which the shared secret will expire. Accepts formats like '30d', '24h', '1w'. Maximum is 30 days, minimum is 5 minutes."},"maxViews":{"type":"number","minimum":1,"description":"The maximum number of times the shared secret can be viewed before it expires. If not provided, unlimited views are allowed."},"accessType":{"type":"string","enum":["anyone","organization"],"default":"organization","description":"Determines who can access the shared secret. 'organization' restricts access to users within your organization. 'anyone' allows access to anyone with the link. Defaults to 'organization'."},"authorizedEmails":{"type":"array","items":{"type":"string","format":"email"},"maxItems":100,"description":"An optional array of email addresses to share the secret with. Maximum 100 emails. Organization members in the list get direct access. When allowExternalEmails is enabled, non-member emails are also accepted and recipients will receive the secret link via email, but must use the password to access it."},"allowExternalEmails":{"type":"boolean","description":"When true, allows sharing with email addresses that do not belong to Infisical. A password is required when this option is enabled. External recipients will receive the secret link via email and must enter the password to access it."}},"required":["secretValue"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"userId":{"type":"string","format":"uuid","nullable":true},"orgId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"expiresAfterViews":{"type":"number","nullable":true},"accessType":{"type":"string","default":"anyone"},"name":{"type":"string","nullable":true},"lastViewedAt":{"type":"string","format":"date-time","nullable":true},"type":{"type":"string","default":"share"},"authorizedEmails":{"nullable":true},"identityId":{"type":"string","format":"uuid","nullable":true},"allowExternalEmails":{"type":"boolean","default":false,"nullable":true},"sharedSecretLink":{"type":"string"}},"required":["id","expiresAt","createdAt","updatedAt","sharedSecretLink"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/shared-secrets/{id}":{"get":{"operationId":"getSharedSecretById","tags":["Secret Sharing"],"description":"Returns the full shared secret object without revealing the secret value. Authentication is required for shared secrets that are scoped to an organization.","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the shared secret to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"userId":{"type":"string","format":"uuid","nullable":true},"orgId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"expiresAfterViews":{"type":"number","nullable":true},"accessType":{"type":"string","default":"anyone"},"name":{"type":"string","nullable":true},"lastViewedAt":{"type":"string","format":"date-time","nullable":true},"type":{"type":"string","default":"share"},"identityId":{"type":"string","format":"uuid","nullable":true},"isPasswordProtected":{"type":"boolean","description":"Whether the shared secret is protected by a password."},"isAuthorizedUser":{"type":"boolean","description":"Whether the current user is an authorized org member. If false, the user must provide a password."}},"required":["id","expiresAt","createdAt","updatedAt","isPasswordProtected","isAuthorizedUser"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteSharedSecret","tags":["Secret Sharing"],"description":"Delete a shared secret by its ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the shared secret to delete."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"userId":{"type":"string","format":"uuid","nullable":true},"orgId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"expiresAfterViews":{"type":"number","nullable":true},"accessType":{"type":"string","default":"anyone"},"name":{"type":"string","nullable":true},"lastViewedAt":{"type":"string","format":"date-time","nullable":true},"type":{"type":"string","default":"share"},"authorizedEmails":{"nullable":true},"identityId":{"type":"string","format":"uuid","nullable":true},"allowExternalEmails":{"type":"boolean","default":false,"nullable":true}},"required":["id","expiresAt","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/shared-secrets/{id}/access":{"post":{"operationId":"accessSharedSecret","tags":["Secret Sharing"],"description":"Access a shared secret by its ID. If the secret is password protected, you must provide the password in the request body. Returns the secret value if access is granted, or an error if access is denied. The endpoint requires authentication if the shared secret is scoped to an organization.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"The password for accessing a password-protected shared secret. Only required if the secret is password protected."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true,"description":"The ID of the shared secret to access."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"userId":{"type":"string","format":"uuid","nullable":true},"orgId":{"type":"string","format":"uuid","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"expiresAfterViews":{"type":"number","nullable":true},"accessType":{"type":"string","default":"anyone"},"name":{"type":"string","nullable":true},"lastViewedAt":{"type":"string","format":"date-time","nullable":true},"type":{"type":"string","default":"share"},"authorizedEmails":{"nullable":true},"identityId":{"type":"string","format":"uuid","nullable":true},"allowExternalEmails":{"type":"boolean","default":false,"nullable":true},"orgName":{"type":"string"},"secretValue":{"type":"string"}},"required":["id","expiresAt","createdAt","updatedAt"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys":{"post":{"operationId":"createKmsKey","tags":["KMS Keys"],"description":"Create KMS key","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","description":"The ID of the project to create the key in."},"name":{"type":"string","minLength":1,"maxLength":32,"description":"The name of the key to be created. Must be slug-friendly."},"description":{"type":"string","maxLength":500,"description":"An optional description of the key."},"keyUsage":{"type":"string","enum":["encrypt-decrypt","sign-verify","generate-verify-mac"],"default":"encrypt-decrypt","description":"The type of key to be created, either encrypt-decrypt or sign-verify, based on your intended use for the key."},"algorithm":{"type":"string","enum":["aes-256-gcm","aes-128-gcm","RSA_4096","ECC_NIST_P256","ECC_NIST_P384","ECC_NIST_P521","ED25519","ML_DSA_44","ML_DSA_65","ML_DSA_87","HMAC_SHA_1","HMAC_SHA_224","HMAC_SHA_256","HMAC_SHA_384","HMAC_SHA_512"],"description":"The cryptographic algorithm of the key (e.g. aes-256-gcm, RSA_4096, HMAC_SHA_256)."},"isExportable":{"type":"boolean","default":true,"description":"Whether the raw key material can be exported after creation. When set to false, the key can never be exported regardless of permissions. This cannot be changed after creation."},"hasDeleteProtection":{"type":"boolean","default":false,"description":"Prevents deletion of the key when enabled."}},"required":["projectId","name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"description":{"type":"string","nullable":true},"isDisabled":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string","nullable":true},"keyUsage":{"type":"string","default":"encrypt-decrypt"},"kmipMetadata":{"nullable":true},"isExportable":{"type":"boolean","default":true},"hasDeleteProtection":{"type":"boolean","default":false},"version":{"type":"number","default":1},"algorithm":{"type":"string"}},"required":["id","orgId","name","createdAt","updatedAt","algorithm"],"additionalProperties":false}},"required":["key"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"listKmsKeys","tags":["KMS Keys"],"description":"List KMS keys","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":true,"description":"The ID of the project to list keys from."},{"schema":{"type":"number","minimum":0,"default":0},"in":"query","name":"offset","required":false,"description":"The offset to start from. If you enter 10, it will start from the 10th key."},{"schema":{"type":"number","minimum":1,"maximum":100,"default":100},"in":"query","name":"limit","required":false,"description":"The number of keys to return."},{"schema":{"type":"string","enum":["name"],"default":"name"},"in":"query","name":"orderBy","required":false,"description":"The column to order keys by."},{"schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"in":"query","name":"orderDirection","required":false,"description":"The direction to order keys in."},{"schema":{"type":"string"},"in":"query","name":"search","required":false,"description":"The text string to filter key names by."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"description":{"type":"string","nullable":true},"isDisabled":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string","nullable":true},"keyUsage":{"type":"string","default":"encrypt-decrypt"},"kmipMetadata":{"nullable":true},"isExportable":{"type":"boolean","default":true},"hasDeleteProtection":{"type":"boolean","default":false},"version":{"type":"number","default":1},"algorithm":{"type":"string"}},"required":["id","orgId","name","createdAt","updatedAt","algorithm"],"additionalProperties":false}},"totalCount":{"type":"number"}},"required":["keys","totalCount"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/{keyId}":{"patch":{"operationId":"updateKmsKey","tags":["KMS Keys"],"description":"Update KMS key","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"The updated name of this key. Must be slug-friendly."},"isDisabled":{"type":"boolean","description":"The flag to enable or disable this key."},"description":{"type":"string","maxLength":500,"description":"The updated description of this key."},"hasDeleteProtection":{"type":"boolean","description":"Enable or disable delete protection for this key."}},"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"keyId","required":true,"description":"The ID of the key to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"description":{"type":"string","nullable":true},"isDisabled":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string","nullable":true},"keyUsage":{"type":"string","default":"encrypt-decrypt"},"kmipMetadata":{"nullable":true},"isExportable":{"type":"boolean","default":true},"hasDeleteProtection":{"type":"boolean","default":false},"version":{"type":"number","default":1},"algorithm":{"type":"string"}},"required":["id","orgId","name","createdAt","updatedAt","algorithm"],"additionalProperties":false}},"required":["key"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteKmsKey","tags":["KMS Keys"],"description":"Delete KMS key","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"keyId","required":true,"description":"The ID of the key to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"description":{"type":"string","nullable":true},"isDisabled":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string","nullable":true},"keyUsage":{"type":"string","default":"encrypt-decrypt"},"kmipMetadata":{"nullable":true},"isExportable":{"type":"boolean","default":true},"hasDeleteProtection":{"type":"boolean","default":false},"version":{"type":"number","default":1},"algorithm":{"type":"string"}},"required":["id","orgId","name","createdAt","updatedAt","algorithm"],"additionalProperties":false}},"required":["key"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"get":{"operationId":"getKmsKeyById","tags":["KMS Keys"],"description":"Get KMS key by ID","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"keyId","required":true,"description":"The ID of the KMS key to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"description":{"type":"string","nullable":true},"isDisabled":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string","nullable":true},"keyUsage":{"type":"string","default":"encrypt-decrypt"},"kmipMetadata":{"nullable":true},"isExportable":{"type":"boolean","default":true},"hasDeleteProtection":{"type":"boolean","default":false},"version":{"type":"number","default":1},"algorithm":{"type":"string"}},"required":["id","orgId","name","createdAt","updatedAt","algorithm"],"additionalProperties":false}},"required":["key"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/{keyId}/rotate":{"post":{"operationId":"rotateKmsKey","tags":["KMS Keys"],"description":"Rotate KMS key. Generates new key material for the key and increments its version. Previous key material is retained so existing ciphertexts remain decryptable; new encrypt operations use the new material. Only supported for encrypt-decrypt keys.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"keyId","required":true,"description":"The ID of the key to be rotated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"description":{"type":"string","nullable":true},"isDisabled":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string","nullable":true},"keyUsage":{"type":"string","default":"encrypt-decrypt"},"kmipMetadata":{"nullable":true},"isExportable":{"type":"boolean","default":true},"hasDeleteProtection":{"type":"boolean","default":false},"version":{"type":"number","default":1},"algorithm":{"type":"string"}},"required":["id","orgId","name","createdAt","updatedAt","algorithm"],"additionalProperties":false}},"required":["key"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/key-name/{keyName}":{"get":{"operationId":"getKmsKeyByName","tags":["KMS Keys"],"description":"Get KMS key by name","parameters":[{"schema":{"type":"string","minLength":1},"in":"query","name":"projectId","required":true,"description":"The ID of the project the key belongs to."},{"schema":{"type":"string","minLength":1,"maxLength":64},"in":"path","name":"keyName","required":true,"description":"The name of the KMS key to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"description":{"type":"string","nullable":true},"isDisabled":{"type":"boolean","default":false,"nullable":true},"orgId":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"projectId":{"type":"string","nullable":true},"keyUsage":{"type":"string","default":"encrypt-decrypt"},"kmipMetadata":{"nullable":true},"isExportable":{"type":"boolean","default":true},"hasDeleteProtection":{"type":"boolean","default":false},"version":{"type":"number","default":1},"algorithm":{"type":"string"}},"required":["id","orgId","name","createdAt","updatedAt","algorithm"],"additionalProperties":false}},"required":["key"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/{keyId}/encrypt":{"post":{"operationId":"encryptWithKmsKey","tags":["KMS Encryption"],"description":"Encrypt data with KMS key","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"plaintext":{"type":"string","description":"The plaintext to be encrypted (base64 encoded)."}},"required":["plaintext"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"keyId","required":true,"description":"The ID of the key to encrypt the data with."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ciphertext":{"type":"string"}},"required":["ciphertext"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/{keyId}/public-key":{"get":{"operationId":"getKmsKeyPublicKey","tags":["KMS Signing"],"description":"Get the public key for a KMS key that is used for signing and verifying data. This endpoint is only available for asymmetric keys.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"keyId","required":true,"description":"The ID of the key to get the public key for. The key must be for signing and verifying."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"publicKey":{"type":"string"}},"required":["publicKey"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/{keyId}/private-key":{"get":{"operationId":"getKmsKeyPrivateKey","tags":["KMS Keys"],"description":"Export the private key (or key material) for a KMS key. For asymmetric keys (sign/verify), the private key is returned. For symmetric keys (encrypt/decrypt), the key material is returned.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"keyId","required":true,"description":"The ID of the key to export the private key or key material for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"privateKey":{"type":"string"}},"required":["privateKey"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/bulk-import":{"post":{"operationId":"bulkImportKmsKeys","tags":["KMS Keys"],"description":"Bulk import KMS keys with provided key material into a project.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","format":"uuid"},"keys":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32},"keyUsage":{"type":"string","enum":["encrypt-decrypt","sign-verify","generate-verify-mac"]},"algorithm":{"type":"string","enum":["aes-256-gcm","aes-128-gcm","RSA_4096","ECC_NIST_P256","ECC_NIST_P384","ECC_NIST_P521","ED25519","ML_DSA_44","ML_DSA_65","ML_DSA_87","HMAC_SHA_1","HMAC_SHA_224","HMAC_SHA_256","HMAC_SHA_384","HMAC_SHA_512"]},"keyMaterial":{"type":"string","minLength":1},"isExportable":{"type":"boolean","default":true,"description":"Whether the raw key material can be exported after creation. When set to false, the key can never be exported regardless of permissions. This cannot be changed after creation."},"hasDeleteProtection":{"type":"boolean","default":false,"description":"Prevents deletion of the key when enabled."}},"required":["name","keyUsage","keyMaterial"],"additionalProperties":false},"minItems":1,"maxItems":100}},"required":["projectId","keys"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"errors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"],"additionalProperties":false}}},"required":["keys","errors"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/bulk-export-private-keys":{"post":{"operationId":"bulkExportKmsKeyPrivateKeys","tags":["KMS Keys"],"description":"Bulk export multiple KMS keys. For asymmetric keys (sign/verify), both private and public keys are returned. For symmetric keys (encrypt/decrypt), the key material is returned.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"keyIds":{"type":"array","items":{"type":"string","format":"uuid","description":"An array of KMS key IDs to export. Maximum 100 keys per request."},"minItems":1,"maxItems":100}},"required":["keyIds"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"keyId":{"type":"string"},"name":{"type":"string"},"keyUsage":{"type":"string"},"algorithm":{"type":"string"},"privateKey":{"type":"string"},"publicKey":{"type":"string"}},"required":["keyId","name","keyUsage","algorithm","privateKey"],"additionalProperties":false}}},"required":["keys"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/{keyId}/signing-algorithms":{"get":{"operationId":"listKmsKeySigningAlgorithms","tags":["KMS Signing"],"description":"List all available signing algorithms for a KMS key","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"keyId","required":true,"description":"The ID of the key to list the signing algorithms for. The key must be for signing and verifying."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"signingAlgorithms":{"type":"array","items":{"type":"string","enum":["RSASSA_PSS_SHA_512","RSASSA_PSS_SHA_384","RSASSA_PSS_SHA_256","RSASSA_PKCS1_V1_5_SHA_512","RSASSA_PKCS1_V1_5_SHA_384","RSASSA_PKCS1_V1_5_SHA_256","ECDSA_SHA_512","ECDSA_SHA_384","ECDSA_SHA_256","ED25519","ML_DSA_44","ML_DSA_65","ML_DSA_87"]}}},"required":["signingAlgorithms"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/{keyId}/sign":{"post":{"operationId":"signWithKmsKey","tags":["KMS Signing"],"description":"Sign data with a KMS key.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"signingAlgorithm":{"type":"string","enum":["RSASSA_PSS_SHA_512","RSASSA_PSS_SHA_384","RSASSA_PSS_SHA_256","RSASSA_PKCS1_V1_5_SHA_512","RSASSA_PKCS1_V1_5_SHA_384","RSASSA_PKCS1_V1_5_SHA_256","ECDSA_SHA_512","ECDSA_SHA_384","ECDSA_SHA_256","ED25519","ML_DSA_44","ML_DSA_65","ML_DSA_87"]},"isDigest":{"type":"boolean","default":false,"description":"Whether the data is already digested or not. Please be aware that if you are passing a digest the algorithm used to create the digest must match the signing algorithm used to sign the digest."},"data":{"type":"string","description":"The data in string format to be signed (base64 encoded)."}},"required":["signingAlgorithm","data"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"keyId","required":true,"description":"The ID of the key to sign the data with."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"signature":{"type":"string"},"keyId":{"type":"string","format":"uuid"},"signingAlgorithm":{"type":"string","enum":["RSASSA_PSS_SHA_512","RSASSA_PSS_SHA_384","RSASSA_PSS_SHA_256","RSASSA_PKCS1_V1_5_SHA_512","RSASSA_PKCS1_V1_5_SHA_384","RSASSA_PKCS1_V1_5_SHA_256","ECDSA_SHA_512","ECDSA_SHA_384","ECDSA_SHA_256","ED25519","ML_DSA_44","ML_DSA_65","ML_DSA_87"]}},"required":["signature","keyId","signingAlgorithm"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/{keyId}/verify":{"post":{"operationId":"verifyWithKmsKey","tags":["KMS Signing"],"description":"Verify data signatures with a KMS key.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"isDigest":{"type":"boolean","default":false,"description":"Whether the data is already digested or not."},"data":{"type":"string","description":"The data in string format to be verified (base64 encoded). For data larger than 1MB you must first create a digest of the data and then pass the digest in the data parameter."},"signature":{"type":"string","description":"The signature to be verified (base64 encoded)."},"signingAlgorithm":{"type":"string","enum":["RSASSA_PSS_SHA_512","RSASSA_PSS_SHA_384","RSASSA_PSS_SHA_256","RSASSA_PKCS1_V1_5_SHA_512","RSASSA_PKCS1_V1_5_SHA_384","RSASSA_PKCS1_V1_5_SHA_256","ECDSA_SHA_512","ECDSA_SHA_384","ECDSA_SHA_256","ED25519","ML_DSA_44","ML_DSA_65","ML_DSA_87"]}},"required":["data","signature","signingAlgorithm"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"keyId","required":true,"description":"The ID of the key to verify the data with."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"signatureValid":{"type":"boolean"},"keyId":{"type":"string","format":"uuid"},"signingAlgorithm":{"type":"string","enum":["RSASSA_PSS_SHA_512","RSASSA_PSS_SHA_384","RSASSA_PSS_SHA_256","RSASSA_PKCS1_V1_5_SHA_512","RSASSA_PKCS1_V1_5_SHA_384","RSASSA_PKCS1_V1_5_SHA_256","ECDSA_SHA_512","ECDSA_SHA_384","ECDSA_SHA_256","ED25519","ML_DSA_44","ML_DSA_65","ML_DSA_87"]}},"required":["signatureValid","keyId","signingAlgorithm"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/{keyId}/generate-mac":{"post":{"operationId":"generateMacWithKmsKey","tags":["KMS Signing"],"description":"Generate an HMAC (MAC) for data with a KMS key.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"string","description":"The data in string format to generate the MAC for (base64 encoded)."}},"required":["data"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"keyId","required":true,"description":"The ID of the key to generate the MAC with. The key must be for generating and verifying MACs."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"mac":{"type":"string"},"keyId":{"type":"string","format":"uuid"},"macAlgorithm":{"type":"string","enum":["HMAC_SHA_1","HMAC_SHA_224","HMAC_SHA_256","HMAC_SHA_384","HMAC_SHA_512"]}},"required":["mac","keyId","macAlgorithm"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/{keyId}/verify-mac":{"post":{"operationId":"verifyMacWithKmsKey","tags":["KMS Signing"],"description":"Verify an HMAC (MAC) for data with a KMS key.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"string","description":"The data in string format the MAC was generated for (base64 encoded)."},"mac":{"type":"string","description":"The MAC to be verified (base64 encoded)."}},"required":["data","mac"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"keyId","required":true,"description":"The ID of the key to verify the MAC with. The key must be for generating and verifying MACs."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"macValid":{"type":"boolean"},"keyId":{"type":"string","format":"uuid"},"macAlgorithm":{"type":"string","enum":["HMAC_SHA_1","HMAC_SHA_224","HMAC_SHA_256","HMAC_SHA_384","HMAC_SHA_512"]}},"required":["macValid","keyId","macAlgorithm"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/kms/keys/{keyId}/decrypt":{"post":{"operationId":"decryptWithKmsKey","tags":["KMS Encryption"],"description":"Decrypt data with KMS key","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ciphertext":{"type":"string","description":"The ciphertext to be decrypted (base64 encoded)."}},"required":["ciphertext"],"additionalProperties":false}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"keyId","required":true,"description":"The ID of the key to decrypt the data with."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"plaintext":{"type":"string"}},"required":["plaintext"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/scim/group-org-role-mappings":{"get":{"operationId":"listExternalGroupOrgRoleMappings","tags":["SCIM"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"groupName":{"type":"string"},"role":{"type":"string"},"roleId":{"type":"string","format":"uuid","nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","groupName","role","orgId","createdAt","updatedAt"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"put":{"operationId":"updateExternalGroupOrgRoleMappings","tags":["SCIM"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mappings":{"type":"array","items":{"type":"object","properties":{"groupName":{"type":"string","minLength":1,"description":"The name of the group in the SCIM provider."},"roleSlug":{"type":"string","minLength":1,"maxLength":64,"description":"The slug of the role that group members should be assigned when provisioned."}},"required":["groupName","roleSlug"],"additionalProperties":false}}},"required":["mappings"],"additionalProperties":false}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"groupName":{"type":"string"},"role":{"type":"string"},"roleId":{"type":"string","format":"uuid","nullable":true},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","groupName","role","orgId","createdAt","updatedAt"],"additionalProperties":false}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/options":{"get":{"operationId":"listAppConnectionOptions","tags":["App Connections"],"description":"List the available App Connection Options.","parameters":[{"schema":{"type":"string","enum":["secret-manager","cert-manager","kms","secret-scanning","pam","agent-vault"]},"in":"query","name":"projectType","required":false}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnectionOptions":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","enum":["AWS"]},"app":{"type":"string","enum":["aws"]},"methods":{"type":"array","items":{"type":"string","enum":["assume-role","access-key"]}},"accessKeyId":{"type":"string"}},"required":["name","app","methods"],"additionalProperties":false,"title":"AWS"},{"type":"object","properties":{"name":{"type":"string","enum":["GitHub"]},"app":{"type":"string","enum":["github"]},"methods":{"type":"array","items":{"type":"string","enum":["oauth","github-app","pat"]}},"oauthClientId":{"type":"string"},"appClientSlug":{"type":"string"}},"required":["name","app","methods"],"additionalProperties":false,"title":"GitHub"},{"type":"object","properties":{"name":{"type":"string","enum":["GitHub Radar"]},"app":{"type":"string","enum":["github-radar"]},"methods":{"type":"array","items":{"type":"string","enum":["github-app"]}},"appClientSlug":{"type":"string"}},"required":["name","app","methods"],"additionalProperties":false,"title":"GitHub Radar"},{"type":"object","properties":{"name":{"type":"string","enum":["GCP"]},"app":{"type":"string","enum":["gcp"]},"methods":{"type":"array","items":{"type":"string","enum":["service-account-impersonation"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"GCP"},{"type":"object","properties":{"name":{"type":"string","enum":["Azure Key Vault"]},"app":{"type":"string","enum":["azure-key-vault"]},"methods":{"type":"array","items":{"type":"string","enum":["oauth","client-secret","certificate"]}},"oauthClientId":{"type":"string"}},"required":["name","app","methods"],"additionalProperties":false,"title":"Azure Key Vault"},{"type":"object","properties":{"name":{"type":"string","enum":["Azure App Configuration"]},"app":{"type":"string","enum":["azure-app-configuration"]},"methods":{"type":"array","items":{"type":"string","enum":["oauth","client-secret"]}},"oauthClientId":{"type":"string"}},"required":["name","app","methods"],"additionalProperties":false,"title":"Azure App Configuration"},{"type":"object","properties":{"name":{"type":"string","enum":["Azure DevOps"]},"app":{"type":"string","enum":["azure-devops"]},"methods":{"type":"array","items":{"type":"string","enum":["oauth","access-token","client-secret"]}},"oauthClientId":{"type":"string"}},"required":["name","app","methods"],"additionalProperties":false,"title":"Azure DevOps"},{"type":"object","properties":{"name":{"type":"string","enum":["Databricks"]},"app":{"type":"string","enum":["databricks"]},"methods":{"type":"array","items":{"type":"string","enum":["service-principal"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Databricks"},{"type":"object","properties":{"name":{"type":"string","enum":["Humanitec"]},"app":{"type":"string","enum":["humanitec"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Humanitec"},{"type":"object","properties":{"name":{"type":"string","enum":["Terraform Cloud"]},"app":{"type":"string","enum":["terraform-cloud"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Terraform Cloud"},{"type":"object","properties":{"name":{"type":"string","enum":["Vercel"]},"app":{"type":"string","enum":["vercel"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Vercel"},{"type":"object","properties":{"name":{"type":"string","enum":["PostgreSQL"]},"app":{"type":"string","enum":["postgres"]},"methods":{"type":"array","items":{"type":"string","enum":["username-and-password"]}},"supportsPlatformManagement":{"type":"boolean","enum":[true]}},"required":["name","app","methods","supportsPlatformManagement"],"additionalProperties":false,"title":"PostgreSQL"},{"type":"object","properties":{"name":{"type":"string","enum":["Microsoft SQL Server"]},"app":{"type":"string","enum":["mssql"]},"methods":{"type":"array","items":{"type":"string","enum":["username-and-password"]}},"supportsPlatformManagement":{"type":"boolean","enum":[true]}},"required":["name","app","methods","supportsPlatformManagement"],"additionalProperties":false,"title":"Microsoft SQL Server"},{"type":"object","properties":{"name":{"type":"string","enum":["MySQL"]},"app":{"type":"string","enum":["mysql"]},"methods":{"type":"array","items":{"type":"string","enum":["username-and-password"]}},"supportsPlatformManagement":{"type":"boolean","enum":[true]}},"required":["name","app","methods","supportsPlatformManagement"],"additionalProperties":false,"title":"MySQL"},{"type":"object","properties":{"name":{"type":"string","enum":["Camunda"]},"app":{"type":"string","enum":["camunda"]},"methods":{"type":"array","items":{"type":"string","enum":["client-credentials"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Camunda"},{"type":"object","properties":{"name":{"type":"string","enum":["Auth0"]},"app":{"type":"string","enum":["auth0"]},"methods":{"type":"array","items":{"type":"string","enum":["client-credentials"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Auth0"},{"type":"object","properties":{"name":{"type":"string","enum":["HCVault"]},"app":{"type":"string","enum":["hashicorp-vault"]},"methods":{"type":"array","items":{"type":"string","enum":["access-token","app-role"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Hashicorp Vault"},{"type":"object","properties":{"name":{"type":"string","enum":["Azure Client Secrets"]},"app":{"type":"string","enum":["azure-client-secrets"]},"methods":{"type":"array","items":{"type":"string","enum":["oauth","client-secret","certificate"]}},"oauthClientId":{"type":"string"}},"required":["name","app","methods"],"additionalProperties":false,"title":"Azure Client Secrets"},{"type":"object","properties":{"name":{"type":"string","enum":["Windmill"]},"app":{"type":"string","enum":["windmill"]},"methods":{"type":"array","items":{"type":"string","enum":["access-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Windmill"},{"type":"object","properties":{"name":{"type":"string","enum":["LDAP"]},"app":{"type":"string","enum":["ldap"]},"methods":{"type":"array","items":{"type":"string","enum":["simple-bind"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"LDAP"},{"type":"object","properties":{"name":{"type":"string","enum":["TeamCity"]},"app":{"type":"string","enum":["teamcity"]},"methods":{"type":"array","items":{"type":"string","enum":["access-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"TeamCity"},{"type":"object","properties":{"name":{"type":"string","enum":["OCI"]},"app":{"type":"string","enum":["oci"]},"methods":{"type":"array","items":{"type":"string","enum":["access-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"OCI"},{"type":"object","properties":{"name":{"type":"string","enum":["OracleDB"]},"app":{"type":"string","enum":["oracledb"]},"methods":{"type":"array","items":{"type":"string","enum":["username-and-password"]}},"supportsPlatformManagement":{"type":"boolean","enum":[true]}},"required":["name","app","methods","supportsPlatformManagement"],"additionalProperties":false,"title":"OracleDB"},{"type":"object","properties":{"name":{"type":"string","enum":["1Password"]},"app":{"type":"string","enum":["1password"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"1Password"},{"type":"object","properties":{"name":{"type":"string","enum":["Heroku"]},"app":{"type":"string","enum":["heroku"]},"methods":{"type":"array","items":{"type":"string","enum":["auth-token","oauth"]}},"oauthClientId":{"type":"string"}},"required":["name","app","methods"],"additionalProperties":false,"title":"Heroku"},{"type":"object","properties":{"name":{"type":"string","enum":["Hasura Cloud"]},"app":{"type":"string","enum":["hasura-cloud"]},"methods":{"type":"array","items":{"type":"string","enum":["access-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Hasura Cloud"},{"type":"object","properties":{"name":{"type":"string","enum":["Render"]},"app":{"type":"string","enum":["render"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Render"},{"type":"object","properties":{"name":{"type":"string","enum":["Fly.io"]},"app":{"type":"string","enum":["flyio"]},"methods":{"type":"array","items":{"type":"string","enum":["access-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Fly.io"},{"type":"object","properties":{"name":{"type":"string","enum":["Trigger.dev"]},"app":{"type":"string","enum":["trigger-dev"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Trigger.dev"},{"type":"object","properties":{"name":{"type":"string","enum":["GitLab"]},"app":{"type":"string","enum":["gitlab"]},"methods":{"type":"array","items":{"type":"string","enum":["oauth","access-token"]}},"oauthClientId":{"type":"string"}},"required":["name","app","methods"],"additionalProperties":false,"title":"GitLab"},{"type":"object","properties":{"name":{"type":"string","enum":["Cloudflare"]},"app":{"type":"string","enum":["cloudflare"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Cloudflare"},{"type":"object","properties":{"name":{"type":"string","enum":["Bitbucket"]},"app":{"type":"string","enum":["bitbucket"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Bitbucket"},{"type":"object","properties":{"name":{"type":"string","enum":["Zabbix"]},"app":{"type":"string","enum":["zabbix"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Zabbix"},{"type":"object","properties":{"name":{"type":"string","enum":["Railway"]},"app":{"type":"string","enum":["railway"]},"methods":{"type":"array","items":{"type":"string","enum":["account-token","project-token","team-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Railway"},{"type":"object","properties":{"name":{"type":"string","enum":["Checkly"]},"app":{"type":"string","enum":["checkly"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Checkly"},{"type":"object","properties":{"name":{"type":"string","enum":["CircleCI"]},"app":{"type":"string","enum":["circleci"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"CircleCI"},{"type":"object","properties":{"name":{"type":"string","enum":["Cloud 66"]},"app":{"type":"string","enum":["cloud-66"]},"methods":{"type":"array","items":{"type":"string","enum":["access-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Cloud 66"},{"type":"object","properties":{"name":{"type":"string","enum":["Supabase"]},"app":{"type":"string","enum":["supabase"]},"methods":{"type":"array","items":{"type":"string","enum":["access-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Supabase"},{"type":"object","properties":{"name":{"type":"string","enum":["Digital Ocean"]},"app":{"type":"string","enum":["digital-ocean"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"DigitalOcean App Platform"},{"type":"object","properties":{"name":{"type":"string","enum":["Netlify"]},"app":{"type":"string","enum":["netlify"]},"methods":{"type":"array","items":{"type":"string","enum":["access-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Netlify"},{"type":"object","properties":{"name":{"type":"string","enum":["Northflank"]},"app":{"type":"string","enum":["northflank"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Northflank"},{"type":"object","properties":{"name":{"type":"string","enum":["Okta"]},"app":{"type":"string","enum":["okta"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Okta"},{"type":"object","properties":{"name":{"type":"string","enum":["Azure ADCS"]},"app":{"type":"string","enum":["azure-adcs"]},"methods":{"type":"array","items":{"type":"string","enum":["username-password"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Azure ADCS (Web Enrollment)"},{"type":"object","properties":{"name":{"type":"string","enum":["ADCS"]},"app":{"type":"string","enum":["adcs"]},"methods":{"type":"array","items":{"type":"string","enum":["username-password"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Microsoft ADCS"},{"type":"object","properties":{"name":{"type":"string","enum":["Windows (WinRM)"]},"app":{"type":"string","enum":["winrm"]},"methods":{"type":"array","items":{"type":"string","enum":["username-password"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Windows (WinRM)"},{"type":"object","properties":{"name":{"type":"string","enum":["Redis"]},"app":{"type":"string","enum":["redis"]},"methods":{"type":"array","items":{"type":"string","enum":["username-and-password"]}},"supportsPlatformManagement":{"type":"boolean","enum":[false]}},"required":["name","app","methods","supportsPlatformManagement"],"additionalProperties":false,"title":"Redis"},{"type":"object","properties":{"name":{"type":"string","enum":["MongoDB"]},"app":{"type":"string","enum":["mongodb"]},"methods":{"type":"array","items":{"type":"string","enum":["username-and-password"]}},"supportsPlatformManagement":{"type":"boolean","enum":[false]}},"required":["name","app","methods","supportsPlatformManagement"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","enum":["Laravel Forge"]},"app":{"type":"string","enum":["laravel-forge"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Laravel Forge"},{"type":"object","properties":{"name":{"type":"string","enum":["Chef"]},"app":{"type":"string","enum":["chef"]},"methods":{"type":"array","items":{"type":"string","enum":["user-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Chef"},{"type":"object","properties":{"name":{"type":"string","enum":["DNS Made Easy"]},"app":{"type":"string","enum":["dns-made-easy"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key-secret"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"DNS Made Easy"},{"type":"object","properties":{"name":{"type":"string","enum":["UltraDNS"]},"app":{"type":"string","enum":["ultradns"]},"methods":{"type":"array","items":{"type":"string","enum":["username-password"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"UltraDNS"},{"type":"object","properties":{"name":{"type":"string","enum":["Azure DNS"]},"app":{"type":"string","enum":["azure-dns"]},"methods":{"type":"array","items":{"type":"string","enum":["client-secret"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Azure DNS"},{"type":"object","properties":{"name":{"type":"string","enum":["Octopus Deploy"]},"app":{"type":"string","enum":["octopus-deploy"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Octopus Deploy"},{"type":"object","properties":{"name":{"type":"string","enum":["Windows (SMB)"]},"app":{"type":"string","enum":["smb"]},"methods":{"type":"array","items":{"type":"string","enum":["credentials"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Windows (SMB)"},{"type":"object","properties":{"name":{"type":"string","enum":["SSH"]},"app":{"type":"string","enum":["ssh"]},"methods":{"type":"array","items":{"type":"string","enum":["password","ssh-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"SSH"},{"type":"object","properties":{"name":{"type":"string","enum":["DBT"]},"app":{"type":"string","enum":["dbt"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"DBT"},{"type":"object","properties":{"name":{"type":"string","enum":["OpenRouter"]},"app":{"type":"string","enum":["open-router"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"OpenRouter"},{"type":"object","properties":{"name":{"type":"string","enum":["OpenAI"]},"app":{"type":"string","enum":["openai"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"OpenAI"},{"type":"object","properties":{"name":{"type":"string","enum":["Azure Entra ID"]},"app":{"type":"string","enum":["azure-entra-id"]},"methods":{"type":"array","items":{"type":"string","enum":["client-secret"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Azure Entra ID"},{"type":"object","properties":{"name":{"type":"string","enum":["Microsoft Intune"]},"app":{"type":"string","enum":["microsoft-intune"]},"methods":{"type":"array","items":{"type":"string","enum":["client-secret"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Microsoft Intune"},{"type":"object","properties":{"name":{"type":"string","enum":["Venafi TLS Protect Cloud"]},"app":{"type":"string","enum":["venafi"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Venafi TLS Protect Cloud"},{"type":"object","properties":{"name":{"type":"string","enum":["Venafi TPP"]},"app":{"type":"string","enum":["venafi-tpp"]},"methods":{"type":"array","items":{"type":"string","enum":["oauth"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Venafi TPP"},{"type":"object","properties":{"name":{"type":"string","enum":["Infisical"]},"app":{"type":"string","enum":["external-infisical"]},"methods":{"type":"array","items":{"type":"string","enum":["machine-identity-universal-auth"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Infisical"},{"type":"object","properties":{"name":{"type":"string","enum":["Doppler"]},"app":{"type":"string","enum":["doppler"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Doppler"},{"type":"object","properties":{"name":{"type":"string","enum":["NetScaler"]},"app":{"type":"string","enum":["netscaler"]},"methods":{"type":"array","items":{"type":"string","enum":["basic-auth"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"NetScaler"},{"type":"object","properties":{"name":{"type":"string","enum":["Kemp LoadMaster"]},"app":{"type":"string","enum":["kemp-loadmaster"]},"methods":{"type":"array","items":{"type":"string","enum":["basic-auth"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Kemp LoadMaster"},{"type":"object","properties":{"name":{"type":"string","enum":["Anthropic"]},"app":{"type":"string","enum":["anthropic"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Anthropic"},{"type":"object","properties":{"name":{"type":"string","enum":["OVH"]},"app":{"type":"string","enum":["ovh"]},"methods":{"type":"array","items":{"type":"string","enum":["certificate"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"OVH"},{"type":"object","properties":{"name":{"type":"string","enum":["Devin"]},"app":{"type":"string","enum":["devin"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Devin"},{"type":"object","properties":{"name":{"type":"string","enum":["Ona"]},"app":{"type":"string","enum":["ona"]},"methods":{"type":"array","items":{"type":"string","enum":["personal-access-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Ona"},{"type":"object","properties":{"name":{"type":"string","enum":["DigiCert"]},"app":{"type":"string","enum":["digicert"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"DigiCert"},{"type":"object","properties":{"name":{"type":"string","enum":["GoDaddy"]},"app":{"type":"string","enum":["godaddy"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"GoDaddy"},{"type":"object","properties":{"name":{"type":"string","enum":["Travis CI"]},"app":{"type":"string","enum":["travis-ci"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Travis CI"},{"type":"object","properties":{"name":{"type":"string","enum":["Salesforce"]},"app":{"type":"string","enum":["salesforce"]},"methods":{"type":"array","items":{"type":"string","enum":["client-credentials"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Salesforce"},{"type":"object","properties":{"name":{"type":"string","enum":["Snowflake"]},"app":{"type":"string","enum":["snowflake"]},"methods":{"type":"array","items":{"type":"string","enum":["username-and-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Snowflake"},{"type":"object","properties":{"name":{"type":"string","enum":["Datadog"]},"app":{"type":"string","enum":["datadog"]},"methods":{"type":"array","items":{"type":"string","enum":["token","api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Datadog"},{"type":"object","properties":{"name":{"type":"string","enum":["F5 BIG-IP"]},"app":{"type":"string","enum":["f5-big-ip"]},"methods":{"type":"array","items":{"type":"string","enum":["basic-auth"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"F5 BIG-IP"},{"type":"object","properties":{"name":{"type":"string","enum":["Convex"]},"app":{"type":"string","enum":["convex"]},"methods":{"type":"array","items":{"type":"string","enum":["personal-access-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Convex"},{"type":"object","properties":{"name":{"type":"string","enum":["Rundeck"]},"app":{"type":"string","enum":["rundeck"]},"methods":{"type":"array","items":{"type":"string","enum":["api-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Rundeck"},{"type":"object","properties":{"name":{"type":"string","enum":["Qovery"]},"app":{"type":"string","enum":["qovery"]},"methods":{"type":"array","items":{"type":"string","enum":["access-token"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Qovery"},{"type":"object","properties":{"name":{"type":"string","enum":["LiteLLM"]},"app":{"type":"string","enum":["litellm"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"LiteLLM"},{"type":"object","properties":{"name":{"type":"string","enum":["Fireworks"]},"app":{"type":"string","enum":["fireworks"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Fireworks"},{"type":"object","properties":{"name":{"type":"string","enum":["Nutanix Prism Central"]},"app":{"type":"string","enum":["nutanix-prism-central"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key","basic-auth"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Nutanix Prism Central"},{"type":"object","properties":{"name":{"type":"string","enum":["PowerDNS"]},"app":{"type":"string","enum":["powerdns"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"PowerDNS"},{"type":"object","properties":{"name":{"type":"string","enum":["Spacelift"]},"app":{"type":"string","enum":["spacelift"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key-secret"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Spacelift"},{"type":"object","properties":{"name":{"type":"string","enum":["Daytona"]},"app":{"type":"string","enum":["daytona"]},"methods":{"type":"array","items":{"type":"string","enum":["api-key"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"Daytona"},{"type":"object","properties":{"name":{"type":"string","enum":["Stripe"]},"app":{"type":"string","enum":["stripe"]},"methods":{"type":"array","items":{"type":"string","enum":["oauth"]}},"oauthClientId":{"type":"string"},"oauthAuthorizeUrl":{"type":"string"}},"required":["name","app","methods"],"additionalProperties":false,"title":"Stripe"},{"type":"object","properties":{"name":{"type":"string","enum":["HPE iLO"]},"app":{"type":"string","enum":["hpe-ilo"]},"methods":{"type":"array","items":{"type":"string","enum":["basic-auth"]}}},"required":["name","app","methods"],"additionalProperties":false,"title":"HPE iLO"}]}}},"required":["appConnectionOptions"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections":{"get":{"operationId":"listAppConnections","tags":["App Connections"],"description":"List all the App Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list App Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["assume-role"]},"credentials":{"type":"object","properties":{"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Assume Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1}},"required":["accessKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Access Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"},"gitHubAppId":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (GitHub App)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["pat"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (Personal Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github-radar"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub Radar (GitHub App)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["gcp"]},"method":{"type":"string","enum":["service-account-impersonation"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GCP (Service Account Impersonation)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Certificate)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"orgName":{"type":"string"}},"required":["orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["clientId","tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["databricks"]},"method":{"type":"string","enum":["service-principal"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1},"workspaceUrl":{"type":"string","format":"uri","minLength":1}},"required":["clientId","workspaceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Databricks (Service Principal)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["humanitec"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Humanitec (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["terraform-cloud"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Terraform Cloud (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["vercel"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Vercel (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["postgres"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PostgreSQL (Username and Password)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mssql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft SQL Server (Username and Password)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mysql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"MySQL (Username and Password)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["camunda"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1,"description":"The client ID used to authenticate with Camunda."}},"required":["clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Camunda (Client Credentials)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["auth0"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"description":"The domain of the Auth0 instance to connect to."},"clientId":{"type":"string","minLength":1,"description":"Your Auth0 application's Client ID."},"audience":{"type":"string","format":"uri","minLength":1,"description":"The unique identifier of the target API you want to access."}},"required":["domain","clientId","audience"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Auth0 (Client Credentials)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["hashicorp-vault"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"namespace":{"type":"string","description":"The Hashicrop Vault namespace to connect with."},"instanceUrl":{"type":"string","minLength":1,"format":"uri","description":"The Hashicrop Vault instance URL to connect with."}},"required":["instanceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Hashicorp Vault (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["hashicorp-vault"]},"method":{"type":"string","enum":["app-role"]},"credentials":{"type":"object","properties":{"namespace":{"type":"string","description":"The Hashicrop Vault namespace to connect with."},"instanceUrl":{"type":"string","minLength":1,"format":"uri","description":"The Hashicrop Vault instance URL to connect with."},"roleId":{"type":"string","minLength":1,"description":"The Role ID used to connect with Hashicorp Vault."}},"required":["instanceUrl","roleId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Hashicorp Vault (App Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"clientId":{"type":"string"}},"required":["tenantId","clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Certificate)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["windmill"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","description":"The Windmill instance URL to connect with (defaults to https://app.windmill.dev)."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Windmill (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["ldap"]},"method":{"type":"string","enum":["simple-bind"]},"credentials":{"type":"object","properties":{"provider":{"type":"string","enum":["active-directory"],"description":"The type of LDAP provider. Determines provider-specific behaviors."},"url":{"type":"string","minLength":1,"description":"The LDAP/LDAPS URL to connect to (e.g., 'ldap://domain-or-ip:389' or 'ldaps://domain-or-ip:636')."},"dn":{"type":"string","minLength":1,"description":"The Distinguished Name (DN) or User Principal Name (UPN) of the principal to bind with (e.g., 'CN=John,CN=Users,DC=example,DC=com')."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates (true/false) when using ldaps://. Set to false only in test environments."},"sslCertificate":{"type":"string","description":"The SSL certificate (PEM format) to use for secure connection when using ldaps:// with a self-signed certificate."}},"required":["provider","url","dn"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"LDAP (Simple Bind)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["teamcity"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","minLength":1,"description":"The TeamCity instance URL to connect with."}},"required":["instanceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"TeamCity (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["oci"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"userOcid":{"type":"string","minLength":1,"description":"The OCID (Oracle Cloud Identifier) of the user making the request."},"tenancyOcid":{"type":"string","minLength":1,"description":"The OCID (Oracle Cloud Identifier) of the tenancy in Oracle Cloud Infrastructure."},"region":{"type":"string","minLength":1,"description":"The region identifier in Oracle Cloud Infrastructure where the vault is located."},"fingerprint":{"type":"string","minLength":1,"description":"The fingerprint of the public key uploaded to the user's API keys."}},"required":["userOcid","tenancyOcid","region","fingerprint"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"OCI (Access Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["oracledb"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"OracleDB (Username and Password)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["1password"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","minLength":1,"description":"The URL of the 1Password Connect Server instance to authenticate with."}},"required":["instanceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"1Password (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["heroku"]},"method":{"type":"string","enum":["auth-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Heroku (Auth Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["heroku"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Heroku (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["hasura-cloud"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Hasura Cloud (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["render"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Render (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["flyio"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Fly.io (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["trigger-dev"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","maxLength":255,"description":"The URL of the Trigger.dev instance to connect to. Defaults to https://api.trigger.dev."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Trigger.dev (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["gitlab"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","description":"The GitLab instance URL to connect with."},"accessTokenType":{"type":"string","enum":["project","personal","group"],"description":"The type of token used to connect with GitLab."}},"required":["accessTokenType"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitLab (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["gitlab"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","description":"The GitLab instance URL to connect with."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitLab (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["cloudflare"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{"accountId":{"type":"string","minLength":1,"maxLength":256}},"required":["accountId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Cloudflare (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["bitbucket"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{"email":{"type":"string","format":"email","minLength":1,"maxLength":255,"description":"The email used to access Bitbucket."}},"required":["email"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Bitbucket (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["zabbix"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","description":"The Zabbix instance URL to connect with."}},"required":["instanceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Zabbix (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["railway"]},"method":{"type":"string","enum":["account-token","project-token","team-token"],"description":"The method used to authenticate with Railway."},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Railway (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["checkly"]},"method":{"type":"string","enum":["api-key"],"description":"The method used to authenticate with Checkly."},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Checkly (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["circleci"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"CircleCI (Personal Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["cloud-66"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Cloud 66 (Personal Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["supabase"]},"method":{"type":"string","enum":["access-token"],"description":"The method used to authenticate with Supabase."},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","maxLength":255,"description":"The URL used to access Supabase."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Supabase (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["digital-ocean"]},"method":{"type":"string","enum":["api-token"],"description":"The method used to authenticate with DigitalOcean App Platform."},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"DigitalOcean App Platform (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["netlify"]},"method":{"type":"string","enum":["access-token"],"description":"The method used to authenticate with Netlify."},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Netlify (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["northflank"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Northflank (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["okta"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","minLength":1,"maxLength":255,"description":"The URL used to access your Okta organization."}},"required":["instanceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Okta (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"username":{"type":"string","minLength":1,"maxLength":255,"description":"The username used to access Azure ADCS (format: 'DOMAIN\\username' or 'username@domain.com')."},"adcsUrl":{"type":"string","minLength":1,"maxLength":255,"description":"The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv')."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate (PEM format) to use for secure connection."}},"required":["username","adcsUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure ADCS (Web Enrollment) (Username and Password)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":255,"description":"The AD CS server's DNS name (FQDN), for example ca01.corp.example.com."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"Windows login: DOMAIN\\user or user@domain."}},"required":["host","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft ADCS (Username and Password)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["winrm"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":255,"description":"The Windows host's DNS name (FQDN) or IP address."},"port":{"type":"integer","minimum":1,"maximum":65535,"default":5985,"description":"The WinRM port. 5985 for HTTP with NTLM message encryption, 5986 for HTTPS."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"Windows login: DOMAIN\\user or user@domain."},"sslEnabled":{"type":"boolean","default":false,"description":"Connect over HTTPS. When disabled, HTTP with NTLM message encryption is used."},"sslRejectUnauthorized":{"type":"boolean","default":true,"description":"Verify the listener's TLS certificate (HTTPS only)."},"sslCertificate":{"type":"string","maxLength":8192,"description":"CA certificate (PEM) used to verify a self-signed WinRM HTTPS listener (HTTPS only)."}},"required":["host","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Windows (WinRM) (Username and Password)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["redis"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1},"port":{"type":"number"},"username":{"type":"string","minLength":1},"sslEnabled":{"type":"boolean"},"sslRejectUnauthorized":{"type":"boolean"},"sslCertificate":{"type":"string"}},"required":["host","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Redis (Username and Password)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mongodb"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1},"port":{"type":"number"},"username":{"type":"string","minLength":1},"database":{"type":"string","minLength":1},"tlsEnabled":{"type":"boolean"},"tlsRejectUnauthorized":{"type":"boolean"},"tlsCertificate":{"type":"string"}},"required":["host","port","username","database","tlsEnabled","tlsRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["laravel-forge"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Laravel Forge (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["chef"]},"method":{"type":"string","enum":["user-key"]},"credentials":{"type":"object","properties":{"serverUrl":{"type":"string","format":"uri","description":"The URL of the Chef server to connect to."},"orgName":{"type":"string","minLength":1,"maxLength":256,"description":"The short name of the Chef organization to connect to."},"userName":{"type":"string","minLength":1,"maxLength":256,"description":"The username used to access Chef."}},"required":["orgName","userName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Chef (User Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["dns-made-easy"]},"method":{"type":"string","enum":["api-key-secret"]},"credentials":{"type":"object","properties":{"apiKey":{"type":"string","minLength":1,"maxLength":256}},"required":["apiKey"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"DNS Made Easy (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["ultradns"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"username":{"type":"string","minLength":1,"maxLength":256,"description":"The username of the UltraDNS user. The user can't have Two Factor Mobile Authentication enabled."},"environment":{"type":"string","enum":["production","test"],"description":"The UltraDNS API to connect to: production (api.ultradns.com) or test (the UltraDNS customer test environment at test-api.ultradns.com)."}},"required":["username","environment"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"UltraDNS (Username & Password)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-dns"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant ID must be a valid GUID"},"subscriptionId":{"type":"string","description":"Subscription ID must be a valid GUID"}},"required":["tenantId","subscriptionId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DNS (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["octopus-deploy"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","minLength":1,"maxLength":255,"description":"The Octopus Deploy instance URL to connect to."}},"required":["instanceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Octopus Deploy (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["smb"]},"method":{"type":"string","enum":["credentials"]},"credentials":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"number"},"domain":{"type":"string"},"username":{"type":"string"}},"required":["host","port","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Windows (SMB)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["ssh"]},"method":{"type":"string","enum":["password"]},"credentials":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"number"},"username":{"type":"string"}},"required":["host","port","username"],"additionalProperties":false},"configuration":{"type":"object","properties":{"blockedUsers":{"type":"string","description":"A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu')."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"SSH (Password)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["ssh"]},"method":{"type":"string","enum":["ssh-key"]},"credentials":{"type":"object","properties":{"host":{"type":"string"},"port":{"type":"number"},"username":{"type":"string"}},"required":["host","port","username"],"additionalProperties":false},"configuration":{"type":"object","properties":{"blockedUsers":{"type":"string","description":"A comma-separated list of usernames that are blocked from being used in operations like secret rotation (e.g., 'root,admin,ubuntu')."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"SSH (SSH Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["dbt"]},"method":{"type":"string","enum":["api-token"],"description":"The method used to authenticate with DBT."},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","minLength":1,"format":"uri","description":"The base URL of your DBT instance."},"accountId":{"type":"string","minLength":1,"maxLength":255,"description":"The account ID of your DBT account."}},"required":["instanceUrl","accountId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"DBT (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["open-router"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"OpenRouter (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["openai"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"OpenAI (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["anthropic"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Anthropic (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["devin"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Devin (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-entra-id"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Entra ID (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["microsoft-intune"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"clientId":{"type":"string"}},"required":["tenantId","clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft Intune (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["venafi"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"region":{"type":"string","enum":["us","eu","au","uk","sg","ca"],"description":"The region of the Venafi TLS Protect Cloud instance"}},"required":["region"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Venafi TLS Protect Cloud (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["venafi-tpp"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tppUrl":{"type":"string","minLength":1,"maxLength":512,"description":"The HTTPS URL of the Venafi TPP instance (e.g., 'https://tpp.example.com'). Must use HTTPS."},"clientId":{"type":"string","minLength":1,"maxLength":255,"description":"The OAuth client ID registered in the Venafi TPP API Integration. Used for token-based authentication."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"The username used to authenticate with Venafi TPP. Supports formats: 'DOMAIN\\\\username', 'username@domain.com', or local usernames."}},"required":["tppUrl","clientId","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Venafi TPP (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["external-infisical"]},"method":{"type":"string","enum":["machine-identity-universal-auth"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","minLength":1,"maxLength":512},"machineIdentityClientId":{"type":"string","format":"uuid","minLength":1}},"required":["instanceUrl","machineIdentityClientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Infisical (Machine Identity - Universal Auth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["netscaler"]},"method":{"type":"string","enum":["basic-auth"]},"credentials":{"type":"object","properties":{"hostname":{"type":"string","minLength":1,"maxLength":512},"port":{"type":"integer","minimum":1,"maximum":65535},"username":{"type":"string","minLength":1,"maxLength":256},"sslRejectUnauthorized":{"type":"boolean"},"sslCertificate":{"type":"string"}},"required":["hostname","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"NetScaler (Basic Auth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["kemp-loadmaster"]},"method":{"type":"string","enum":["basic-auth"]},"credentials":{"type":"object","properties":{"hostname":{"type":"string","minLength":1,"maxLength":512},"port":{"type":"integer","minimum":1,"maximum":65535},"username":{"type":"string","minLength":1,"maxLength":256},"sslRejectUnauthorized":{"type":"boolean"},"sslCertificate":{"type":"string"}},"required":["hostname","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Kemp LoadMaster (Basic Auth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["doppler"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Doppler (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["ovh"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"okmsDomain":{"type":"string","minLength":1,"format":"uri","description":"The OKMS base URL (e.g., 'https://ca-east-bhs.okms.ovh.net')."},"okmsId":{"type":"string","minLength":1,"description":"The OKMS instance identifier from the OVH Control Panel, used as a path segment in all API calls."}},"required":["okmsDomain","okmsId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"OVH (Certificate)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["ona"]},"method":{"type":"string","enum":["personal-access-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Ona (Personal Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["digicert"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"region":{"type":"string","enum":["us","eu"],"description":"The CertCentral region the API key belongs to (us or eu)."}},"required":["region"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"DigiCert (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["godaddy"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GoDaddy (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["travis-ci"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Travis CI (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["salesforce"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","minLength":1,"description":"The instance URL of the Salesforce org to connect to."}},"required":["instanceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Salesforce (Client Credentials)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["snowflake"]},"method":{"type":"string","enum":["username-and-token"]},"credentials":{"type":"object","properties":{"account":{"type":"string","minLength":1,"description":"The Snowflake account identifier (e.g., xy12345.us-east-1)."},"username":{"type":"string","minLength":1,"description":"The username (login name) used to authenticate with Snowflake."}},"required":["account","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Snowflake (Username and Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["datadog"]},"method":{"type":"string","enum":["token"]},"credentials":{"type":"object","properties":{"url":{"type":"string","format":"uri","minLength":1,"maxLength":255,"description":"The Datadog site URL to connect to (e.g., 'https://api.datadoghq.com')."}},"required":["url"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Datadog (Service Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["datadog"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"url":{"type":"string","format":"uri","minLength":1,"maxLength":255,"description":"The Datadog site URL to connect to (e.g., 'https://api.datadoghq.com')."}},"required":["url"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Datadog (Application Keys)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["f5-big-ip"]},"method":{"type":"string","enum":["basic-auth"]},"credentials":{"type":"object","properties":{"hostname":{"type":"string","minLength":1,"maxLength":512},"port":{"type":"integer","minimum":1,"maximum":65535},"username":{"type":"string","minLength":1,"maxLength":256},"sslRejectUnauthorized":{"type":"boolean"},"sslCertificate":{"type":"string"}},"required":["hostname","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"F5 BIG-IP (Basic Auth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["convex"]},"method":{"type":"string","enum":["personal-access-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","description":"The Convex API instance URL. Defaults to 'https://api.convex.dev' if not provided."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Convex (Personal Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["rundeck"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","minLength":1,"maxLength":255,"description":"The Rundeck instance URL to connect to."}},"required":["instanceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Rundeck (API Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["qovery"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Qovery (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["litellm"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","minLength":1,"format":"uri","description":"The base URL of your LiteLLM instance (e.g. https://litellm.example.com)."}},"required":["instanceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"LiteLLM (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["fireworks"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"accountId":{"type":"string","minLength":1,"pattern":"^[a-zA-Z0-9_-]+$","description":"The Fireworks account ID used to identify the Fireworks account."}},"required":["accountId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Fireworks (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["nutanix-prism-central"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"hostname":{"type":"string","minLength":1,"maxLength":512},"port":{"type":"integer","minimum":1,"maximum":65535},"sslRejectUnauthorized":{"type":"boolean"},"sslCertificate":{"type":"string"}},"required":["hostname"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Nutanix Prism Central (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["nutanix-prism-central"]},"method":{"type":"string","enum":["basic-auth"]},"credentials":{"type":"object","properties":{"hostname":{"type":"string","minLength":1,"maxLength":512},"port":{"type":"integer","minimum":1,"maximum":65535},"username":{"type":"string","minLength":1,"maxLength":256},"sslRejectUnauthorized":{"type":"boolean"},"sslCertificate":{"type":"string"}},"required":["hostname","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Nutanix Prism Central (Basic Auth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["powerdns"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"apiUrl":{"type":"string","format":"uri","maxLength":512,"description":"The base URL of the PowerDNS web server, excluding the /api/v1 path."},"serverId":{"type":"string","maxLength":64,"description":"The PowerDNS API server ID. Leave unset unless you connect through a proxy fronting several servers; the Authoritative Server always reports 'localhost'."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether to reject PowerDNS TLS certificates that are not trusted. Defaults to true."},"sslCertificate":{"type":"string","maxLength":8192,"description":"A PEM-encoded CA certificate to trust when connecting to PowerDNS over HTTPS."}},"required":["apiUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PowerDNS (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["spacelift"]},"method":{"type":"string","enum":["api-key-secret"]},"credentials":{"type":"object","properties":{"apiUrl":{"type":"string","format":"uri","minLength":1,"maxLength":256},"apiKeyId":{"type":"string","minLength":1,"maxLength":256}},"required":["apiUrl","apiKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Spacelift (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["daytona"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":255,"description":"The Daytona organization the API key belongs to. Resolved from Daytona when the connection is created."}},"required":["organizationId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Daytona (API Key)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["stripe"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"accountId":{"type":"string"}},"required":["accountId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Stripe (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["hpe-ilo"]},"method":{"type":"string","enum":["basic-auth"]},"credentials":{"type":"object","properties":{"hostname":{"type":"string","minLength":1,"maxLength":512,"description":"The hostname or IP address of the HPE iLO management interface (e.g., 'ilo.example.com')."},"port":{"type":"integer","minimum":1,"maximum":65535,"description":"The HTTPS port of the HPE iLO Redfish API (default: 443)."},"username":{"type":"string","minLength":1,"maxLength":256,"description":"The iLO local account username used to authenticate with the Redfish API."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject untrusted SSL certificates (true/false). Set to false for iLO interfaces using self-signed certificates."},"sslCertificate":{"type":"string","maxLength":16384,"description":"The CA certificate (PEM format) used to verify the iLO interface's TLS certificate."}},"required":["hostname","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"HPE iLO (Basic Auth)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/aws":{"get":{"operationId":"listAwsAppConnections","tags":["App Connections"],"description":"List the AWS Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list AWS Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["assume-role"]},"credentials":{"type":"object","properties":{"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Assume Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1}},"required":["accessKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Access Key)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAwsAppConnection","tags":["App Connections"],"description":"Create an AWS Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["assume-role"],"description":"The method used to authenticate with AWS."},"credentials":{"type":"object","properties":{"roleArn":{"type":"string","minLength":1},"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"required":["roleArn"],"additionalProperties":false,"description":"The credentials used to connect with AWS."}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["access-key"],"description":"The method used to authenticate with AWS."},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1},"secretAccessKey":{"type":"string","minLength":1}},"required":["accessKeyId","secretAccessKey"],"additionalProperties":false,"description":"The credentials used to connect with AWS."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the AWS Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the AWS Connection."},"projectId":{"type":"string","description":"The ID of the project to create the AWS Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for AWS Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for AWS Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for AWS Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for AWS Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for AWS Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["assume-role"]},"credentials":{"type":"object","properties":{"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Assume Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1}},"required":["accessKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Access Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/aws/available":{"get":{"operationId":"listAwsAvailableAppConnections","tags":["App Connections"],"description":"List the AWS Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list AWS Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["aws"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/aws/{connectionId}":{"get":{"operationId":"getAwsAppConnection","tags":["App Connections"],"description":"Get the specified AWS Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the AWS Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["assume-role"]},"credentials":{"type":"object","properties":{"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Assume Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1}},"required":["accessKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Access Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAwsAppConnection","tags":["App Connections"],"description":"Update the specified AWS Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"anyOf":[{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1},"secretAccessKey":{"type":"string","minLength":1}},"required":["accessKeyId","secretAccessKey"],"additionalProperties":false},{"type":"object","properties":{"roleArn":{"type":"string","minLength":1},"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"required":["roleArn"],"additionalProperties":false}],"description":"The credentials used to connect with AWS."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the AWS Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the AWS Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for AWS Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for AWS Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for AWS Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for AWS Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for AWS Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the AWS Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["assume-role"]},"credentials":{"type":"object","properties":{"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Assume Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1}},"required":["accessKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Access Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAwsAppConnection","tags":["App Connections"],"description":"Delete the specified AWS Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the AWS Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["assume-role"]},"credentials":{"type":"object","properties":{"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Assume Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1}},"required":["accessKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Access Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/aws/connection-name/{connectionName}":{"get":{"operationId":"getAwsAppConnectionByName","tags":["App Connections"],"description":"Get the specified AWS Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the AWS Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the AWS Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["assume-role"]},"credentials":{"type":"object","properties":{"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Assume Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1}},"required":["accessKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Access Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/aws/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateAwsAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified AWS Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the AWS Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["assume-role"]},"credentials":{"type":"object","properties":{"stsEndpoint":{"type":"string","format":"uri","pattern":"^https\\:\\/\\/","description":"An optional custom endpoint URL for the AWS STS API to use when connecting with AWS."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Assume Role)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["aws"]},"method":{"type":"string","enum":["access-key"]},"credentials":{"type":"object","properties":{"accessKeyId":{"type":"string","minLength":1}},"required":["accessKeyId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"AWS (Access Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/github":{"get":{"operationId":"listGitHubAppConnections","tags":["App Connections"],"description":"List the GitHub Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list GitHub Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"},"gitHubAppId":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (GitHub App)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["pat"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (Personal Access Token)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createGitHubAppConnection","tags":["App Connections"],"description":"Create a GitHub Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["github-app"],"description":"The method used to authenticate with GitHub."},"credentials":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1},"installationId":{"type":"string","minLength":1},"gitHubAppId":{"type":"string","format":"uuid","nullable":true},"instanceType":{"type":"string","enum":["server"]},"host":{"type":"string","minLength":1}},"required":["code","installationId","instanceType","host"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","minLength":1},"installationId":{"type":"string","minLength":1},"gitHubAppId":{"type":"string","format":"uuid","nullable":true},"instanceType":{"type":"string","enum":["cloud"]},"host":{"type":"string"}},"required":["code","installationId"],"additionalProperties":false}],"description":"The credentials used to connect with GitHub."}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["oauth"],"description":"The method used to authenticate with GitHub."},"credentials":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1},"instanceType":{"type":"string","enum":["server"]},"host":{"type":"string","minLength":1}},"required":["code","instanceType","host"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","minLength":1},"instanceType":{"type":"string","enum":["cloud"]},"host":{"type":"string"}},"required":["code"],"additionalProperties":false}],"description":"The credentials used to connect with GitHub."}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["pat"],"description":"The method used to authenticate with GitHub."},"credentials":{"anyOf":[{"type":"object","properties":{"personalAccessToken":{"type":"string","minLength":1},"instanceType":{"type":"string","enum":["server"]},"host":{"type":"string","minLength":1}},"required":["personalAccessToken","instanceType","host"],"additionalProperties":false},{"type":"object","properties":{"personalAccessToken":{"type":"string","minLength":1},"instanceType":{"type":"string","enum":["cloud"]},"host":{"type":"string"}},"required":["personalAccessToken"],"additionalProperties":false}],"description":"The credentials used to connect with GitHub."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the GitHub Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the GitHub Connection."},"projectId":{"type":"string","description":"The ID of the project to create the GitHub Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for GitHub Connections."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for GitHub Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GitHub Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"},"gitHubAppId":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (GitHub App)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["pat"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (Personal Access Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/github/available":{"get":{"operationId":"listGitHubAvailableAppConnections","tags":["App Connections"],"description":"List the GitHub Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list GitHub Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["github"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/github/{connectionId}":{"get":{"operationId":"getGitHubAppConnection","tags":["App Connections"],"description":"Get the specified GitHub Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the GitHub Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"},"gitHubAppId":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (GitHub App)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["pat"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (Personal Access Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateGitHubAppConnection","tags":["App Connections"],"description":"Update the specified GitHub Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"anyOf":[{"anyOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1},"installationId":{"type":"string","minLength":1},"gitHubAppId":{"type":"string","format":"uuid","nullable":true},"instanceType":{"type":"string","enum":["server"]},"host":{"type":"string","minLength":1}},"required":["code","installationId","instanceType","host"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","minLength":1},"installationId":{"type":"string","minLength":1},"gitHubAppId":{"type":"string","format":"uuid","nullable":true},"instanceType":{"type":"string","enum":["cloud"]},"host":{"type":"string"}},"required":["code","installationId"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1},"instanceType":{"type":"string","enum":["server"]},"host":{"type":"string","minLength":1}},"required":["code","instanceType","host"],"additionalProperties":false},{"type":"object","properties":{"code":{"type":"string","minLength":1},"instanceType":{"type":"string","enum":["cloud"]},"host":{"type":"string"}},"required":["code"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"personalAccessToken":{"type":"string","minLength":1},"instanceType":{"type":"string","enum":["server"]},"host":{"type":"string","minLength":1}},"required":["personalAccessToken","instanceType","host"],"additionalProperties":false},{"type":"object","properties":{"personalAccessToken":{"type":"string","minLength":1},"instanceType":{"type":"string","enum":["cloud"]},"host":{"type":"string"}},"required":["personalAccessToken"],"additionalProperties":false}]}],"description":"The credentials used to connect with GitHub."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the GitHub Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the GitHub Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for GitHub Connections."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for GitHub Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GitHub Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the GitHub Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"},"gitHubAppId":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (GitHub App)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["pat"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (Personal Access Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteGitHubAppConnection","tags":["App Connections"],"description":"Delete the specified GitHub Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the GitHub Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"},"gitHubAppId":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (GitHub App)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["pat"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (Personal Access Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/github/connection-name/{connectionName}":{"get":{"operationId":"getGitHubAppConnectionByName","tags":["App Connections"],"description":"Get the specified GitHub Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the GitHub Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the GitHub Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"},"gitHubAppId":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (GitHub App)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["pat"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (Personal Access Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/github/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateGitHubAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified GitHub Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the GitHub Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"},"gitHubAppId":{"type":"string","format":"uuid","nullable":true}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (GitHub App)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github"]},"method":{"type":"string","enum":["pat"]},"credentials":{"type":"object","properties":{"instanceType":{"anyOf":[{"type":"string","enum":["server"]},{"type":"string","enum":["cloud"]}]},"host":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub (Personal Access Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/github-radar":{"get":{"operationId":"listGitHubRadarAppConnections","tags":["App Connections"],"description":"List the GitHub Radar Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list GitHub Radar Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github-radar"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub Radar (GitHub App)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createGitHubRadarAppConnection","tags":["App Connections"],"description":"Create a GitHub Radar Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["github-app"],"description":"The method used to authenticate with GitHub Radar."},"credentials":{"type":"object","properties":{"code":{"type":"string","minLength":1},"installationId":{"type":"string","minLength":1}},"required":["code","installationId"],"additionalProperties":false,"description":"The credentials used to connect with GitHub Radar."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the GitHub Radar Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the GitHub Radar Connection."},"projectId":{"type":"string","description":"The ID of the project to create the GitHub Radar Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for GitHub Radar Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GitHub Radar Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GitHub Radar Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for GitHub Radar Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GitHub Radar Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github-radar"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub Radar (GitHub App)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/github-radar/available":{"get":{"operationId":"listGitHubRadarAvailableAppConnections","tags":["App Connections"],"description":"List the GitHub Radar Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list GitHub Radar Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["github-radar"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/github-radar/{connectionId}":{"get":{"operationId":"getGitHubRadarAppConnection","tags":["App Connections"],"description":"Get the specified GitHub Radar Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the GitHub Radar Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github-radar"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub Radar (GitHub App)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateGitHubRadarAppConnection","tags":["App Connections"],"description":"Update the specified GitHub Radar Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"code":{"type":"string","minLength":1},"installationId":{"type":"string","minLength":1}},"required":["code","installationId"],"additionalProperties":false,"description":"The credentials used to connect with GitHub Radar."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the GitHub Radar Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the GitHub Radar Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for GitHub Radar Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GitHub Radar Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GitHub Radar Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for GitHub Radar Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GitHub Radar Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the GitHub Radar Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github-radar"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub Radar (GitHub App)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteGitHubRadarAppConnection","tags":["App Connections"],"description":"Delete the specified GitHub Radar Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the GitHub Radar Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github-radar"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub Radar (GitHub App)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/github-radar/connection-name/{connectionName}":{"get":{"operationId":"getGitHubRadarAppConnectionByName","tags":["App Connections"],"description":"Get the specified GitHub Radar Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the GitHub Radar Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the GitHub Radar Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github-radar"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub Radar (GitHub App)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/github-radar/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateGitHubRadarAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified GitHub Radar Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the GitHub Radar Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["github-radar"]},"method":{"type":"string","enum":["github-app"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GitHub Radar (GitHub App)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/gcp":{"get":{"operationId":"listGcpAppConnections","tags":["App Connections"],"description":"List the GCP Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list GCP Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["gcp"]},"method":{"type":"string","enum":["service-account-impersonation"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GCP (Service Account Impersonation)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createGcpAppConnection","tags":["App Connections"],"description":"Create a GCP Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["service-account-impersonation"],"description":"The method used to authenticate with GCP."},"credentials":{"type":"object","properties":{"serviceAccountEmail":{"type":"string","format":"email","minLength":1}},"required":["serviceAccountEmail"],"additionalProperties":false,"description":"The credentials used to connect with GCP."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the GCP Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the GCP Connection."},"projectId":{"type":"string","description":"The ID of the project to create the GCP Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for GCP Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GCP Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GCP Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for GCP Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GCP Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["gcp"]},"method":{"type":"string","enum":["service-account-impersonation"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GCP (Service Account Impersonation)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/gcp/available":{"get":{"operationId":"listGcpAvailableAppConnections","tags":["App Connections"],"description":"List the GCP Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list GCP Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["gcp"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/gcp/{connectionId}":{"get":{"operationId":"getGcpAppConnection","tags":["App Connections"],"description":"Get the specified GCP Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the GCP Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["gcp"]},"method":{"type":"string","enum":["service-account-impersonation"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GCP (Service Account Impersonation)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateGcpAppConnection","tags":["App Connections"],"description":"Update the specified GCP Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"serviceAccountEmail":{"type":"string","format":"email","minLength":1}},"required":["serviceAccountEmail"],"additionalProperties":false,"description":"The credentials used to connect with GCP."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the GCP Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the GCP Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for GCP Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GCP Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GCP Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for GCP Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for GCP Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the GCP Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["gcp"]},"method":{"type":"string","enum":["service-account-impersonation"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GCP (Service Account Impersonation)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteGcpAppConnection","tags":["App Connections"],"description":"Delete the specified GCP Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the GCP Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["gcp"]},"method":{"type":"string","enum":["service-account-impersonation"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GCP (Service Account Impersonation)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/gcp/connection-name/{connectionName}":{"get":{"operationId":"getGcpAppConnectionByName","tags":["App Connections"],"description":"Get the specified GCP Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the GCP Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the GCP Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["gcp"]},"method":{"type":"string","enum":["service-account-impersonation"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GCP (Service Account Impersonation)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/gcp/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateGcpAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified GCP Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the GCP Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["gcp"]},"method":{"type":"string","enum":["service-account-impersonation"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"GCP (Service Account Impersonation)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-key-vault":{"get":{"operationId":"listAzureKeyVaultAppConnections","tags":["App Connections"],"description":"List the Azure Key Vault Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Azure Key Vault Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Certificate)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAzureKeyVaultAppConnection","tags":["App Connections"],"description":"Create an Azure Key Vault Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["oauth"],"description":"The method used to authenticate with Azure Key Vault."},"credentials":{"type":"object","properties":{"code":{"type":"string","minLength":1},"tenantId":{"type":"string"}},"required":["code"],"additionalProperties":false,"description":"The credentials used to connect with Azure Key Vault."}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["client-secret"],"description":"The method used to authenticate with Azure Key Vault."},"credentials":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","minLength":1,"maxLength":50},"clientSecret":{"type":"string","minLength":1,"maxLength":50},"tenantId":{"type":"string","format":"uuid","minLength":1},"clientSecretKeyId":{"type":"string","format":"uuid","description":"The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked."}},"required":["clientId","clientSecret","tenantId"],"additionalProperties":false,"description":"The credentials used to connect with Azure Key Vault."}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["certificate"],"description":"The method used to authenticate with Azure Key Vault."},"credentials":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","minLength":1},"clientId":{"type":"string","format":"uuid","minLength":1},"certificateBody":{"type":"string","minLength":1},"privateKey":{"type":"string","minLength":1}},"required":["tenantId","clientId","certificateBody","privateKey"],"additionalProperties":false,"description":"The credentials used to connect with Azure Key Vault."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Azure Key Vault Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Azure Key Vault Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Azure Key Vault Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Azure Key Vault Connections."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","description":"Whether or not automatic credential rotation is enabled for the Azure Key Vault Connection."},"rotation":{"type":"object","properties":{"rotationInterval":{"type":"integer","minimum":1,"maximum":365,"description":"The interval in days between credential rotations."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"integer","minimum":0,"maximum":23,"description":"The hour (0-23) at which to rotate (UTC timezone)."},"minutes":{"type":"integer","minimum":0,"maximum":59,"description":"The minute (0-59) at which to rotate (UTC timezone)."}},"required":["hours","minutes"],"additionalProperties":false}},"required":["rotationInterval","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration for the Azure Key Vault Connection."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Certificate)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-key-vault/available":{"get":{"operationId":"listAzureKeyVaultAvailableAppConnections","tags":["App Connections"],"description":"List the Azure Key Vault Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Azure Key Vault Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["azure-key-vault"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-key-vault/{connectionId}":{"get":{"operationId":"getAzureKeyVaultAppConnection","tags":["App Connections"],"description":"Get the specified Azure Key Vault Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure Key Vault Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Certificate)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAzureKeyVaultAppConnection","tags":["App Connections"],"description":"Update the specified Azure Key Vault Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1},"tenantId":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","minLength":1,"maxLength":50},"clientSecret":{"type":"string","minLength":1,"maxLength":50},"tenantId":{"type":"string","format":"uuid","minLength":1},"clientSecretKeyId":{"type":"string","format":"uuid","description":"The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked."}},"required":["clientId","clientSecret","tenantId"],"additionalProperties":false},{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","minLength":1},"clientId":{"type":"string","format":"uuid","minLength":1},"certificateBody":{"type":"string","minLength":1},"privateKey":{"type":"string","minLength":1}},"required":["tenantId","clientId","certificateBody","privateKey"],"additionalProperties":false}],"description":"The credentials used to connect with Azure Key Vault."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Azure Key Vault Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Azure Key Vault Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Azure Key Vault Connections."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","description":"Whether or not automatic credential rotation is enabled for the Azure Key Vault Connection."},"rotation":{"type":"object","properties":{"rotationInterval":{"type":"integer","minimum":1,"maximum":365,"description":"The interval in days between credential rotations."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"integer","minimum":0,"maximum":23,"description":"The hour (0-23) at which to rotate (UTC timezone)."},"minutes":{"type":"integer","minimum":0,"maximum":59,"description":"The minute (0-59) at which to rotate (UTC timezone)."}},"required":["hours","minutes"],"additionalProperties":false}},"additionalProperties":false,"description":"The updated credential rotation configuration for the Azure Key Vault Connection."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure Key Vault Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Certificate)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAzureKeyVaultAppConnection","tags":["App Connections"],"description":"Delete the specified Azure Key Vault Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure Key Vault Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Certificate)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-key-vault/connection-name/{connectionName}":{"get":{"operationId":"getAzureKeyVaultAppConnectionByName","tags":["App Connections"],"description":"Get the specified Azure Key Vault Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Azure Key Vault Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Azure Key Vault Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Certificate)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-key-vault/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateAzureKeyVaultAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Azure Key Vault Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure Key Vault Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-key-vault"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Key Vault (Certificate)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-app-configuration":{"get":{"operationId":"listAzureAppConfigurationAppConnections","tags":["App Connections"],"description":"List the Azure App Configuration Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Azure App Configuration Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (Client Secret)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAzureAppConfigurationAppConnection","tags":["App Connections"],"description":"Create an Azure App Configuration Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["oauth"],"description":"The method used to authenticate with Azure App Configuration."},"credentials":{"type":"object","properties":{"code":{"type":"string","minLength":1},"tenantId":{"type":"string"}},"required":["code"],"additionalProperties":false,"description":"The credentials used to connect with Azure App Configuration."}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["client-secret"],"description":"The method used to authenticate with Azure App Configuration."},"credentials":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","minLength":1,"maxLength":50},"clientSecret":{"type":"string","minLength":1,"maxLength":50},"tenantId":{"type":"string","format":"uuid","minLength":1},"clientSecretKeyId":{"type":"string","format":"uuid","description":"The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked."}},"required":["clientId","clientSecret","tenantId"],"additionalProperties":false,"description":"The credentials used to connect with Azure App Configuration."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Azure App Configuration Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Azure App Configuration Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Azure App Configuration Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Azure App Configuration Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure App Configuration Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure App Configuration Connections."},"isAutoRotationEnabled":{"type":"boolean","description":"Whether or not automatic credential rotation is enabled for the Azure App Configuration Connection."},"rotation":{"type":"object","properties":{"rotationInterval":{"type":"integer","minimum":1,"maximum":365,"description":"The interval in days between credential rotations."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"integer","minimum":0,"maximum":23,"description":"The hour (0-23) at which to rotate (UTC timezone)."},"minutes":{"type":"integer","minimum":0,"maximum":59,"description":"The minute (0-59) at which to rotate (UTC timezone)."}},"required":["hours","minutes"],"additionalProperties":false}},"required":["rotationInterval","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration for the Azure App Configuration Connection."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-app-configuration/available":{"get":{"operationId":"listAzureAppConfigurationAvailableAppConnections","tags":["App Connections"],"description":"List the Azure App Configuration Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Azure App Configuration Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["azure-app-configuration"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-app-configuration/{connectionId}":{"get":{"operationId":"getAzureAppConfigurationAppConnection","tags":["App Connections"],"description":"Get the specified Azure App Configuration Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure App Configuration Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAzureAppConfigurationAppConnection","tags":["App Connections"],"description":"Update the specified Azure App Configuration Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1},"tenantId":{"type":"string"}},"required":["code"],"additionalProperties":false},{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","minLength":1,"maxLength":50},"clientSecret":{"type":"string","minLength":1,"maxLength":50},"tenantId":{"type":"string","format":"uuid","minLength":1},"clientSecretKeyId":{"type":"string","format":"uuid","description":"The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked."}},"required":["clientId","clientSecret","tenantId"],"additionalProperties":false}],"description":"The credentials used to connect with Azure App Configuration."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Azure App Configuration Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Azure App Configuration Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Azure App Configuration Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure App Configuration Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure App Configuration Connections."},"isAutoRotationEnabled":{"type":"boolean","description":"Whether or not automatic credential rotation is enabled for the Azure App Configuration Connection."},"rotation":{"type":"object","properties":{"rotationInterval":{"type":"integer","minimum":1,"maximum":365,"description":"The interval in days between credential rotations."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"integer","minimum":0,"maximum":23,"description":"The hour (0-23) at which to rotate (UTC timezone)."},"minutes":{"type":"integer","minimum":0,"maximum":59,"description":"The minute (0-59) at which to rotate (UTC timezone)."}},"required":["hours","minutes"],"additionalProperties":false}},"additionalProperties":false,"description":"The updated credential rotation configuration for the Azure App Configuration Connection."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure App Configuration Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAzureAppConfigurationAppConnection","tags":["App Connections"],"description":"Delete the specified Azure App Configuration Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure App Configuration Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-app-configuration/connection-name/{connectionName}":{"get":{"operationId":"getAzureAppConfigurationAppConnectionByName","tags":["App Connections"],"description":"Get the specified Azure App Configuration Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Azure App Configuration Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Azure App Configuration Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-app-configuration/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateAzureAppConfigurationAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Azure App Configuration Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure App Configuration Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-app-configuration"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure App Configuration (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-client-secrets":{"get":{"operationId":"listAzureClientSecretsAppConnections","tags":["App Connections"],"description":"List the Azure Client Secrets Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Azure Client Secrets Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"clientId":{"type":"string"}},"required":["tenantId","clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Certificate)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAzureClientSecretsAppConnection","tags":["App Connections"],"description":"Create an Azure Client Secrets Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["oauth"],"description":"The method used to authenticate with Azure Client Secrets."},"credentials":{"type":"object","properties":{"code":{"type":"string","minLength":1,"description":"The OAuth code to use to connect with Azure Client Secrets."},"tenantId":{"type":"string","minLength":1,"description":"The Tenant ID to use to connect with Azure Client Secrets."}},"required":["code","tenantId"],"additionalProperties":false,"description":"The credentials used to connect with Azure Client Secrets."}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["client-secret"],"description":"The method used to authenticate with Azure Client Secrets."},"credentials":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","minLength":1,"maxLength":50,"description":"The Client ID to use to connect with Azure Client Secrets."},"clientSecret":{"type":"string","minLength":1,"maxLength":50,"description":"The Client Secret to use to connect with Azure Client Secrets."},"tenantId":{"type":"string","format":"uuid","minLength":1,"description":"The Tenant ID to use to connect with Azure Client Secrets."},"clientSecretKeyId":{"type":"string","format":"uuid","description":"The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked."}},"required":["clientId","clientSecret","tenantId"],"additionalProperties":false,"description":"The credentials used to connect with Azure Client Secrets."}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["certificate"],"description":"The method used to authenticate with Azure Client Secrets."},"credentials":{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","minLength":1,"description":"The Tenant ID to use to connect with Azure Client Secrets."},"clientId":{"type":"string","format":"uuid","minLength":1,"description":"The Client ID to use to connect with Azure Client Secrets."},"certificateBody":{"type":"string","minLength":1,"description":"The certificate body in PEM format to use to connect with Azure Client Secrets."},"privateKey":{"type":"string","minLength":1,"description":"The private key to use to connect with Azure Client Secrets. This is never transmitted to Azure and is only used to sign the Azure client assertion with."}},"required":["tenantId","clientId","certificateBody","privateKey"],"additionalProperties":false,"description":"The credentials used to connect with Azure Client Secrets."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Azure Client Secrets Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Azure Client Secrets Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Azure Client Secrets Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Azure Client Secrets Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure Client Secrets Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure Client Secrets Connections."},"isAutoRotationEnabled":{"type":"boolean","description":"Whether or not automatic credential rotation is enabled for the Azure Client Secrets Connection."},"rotation":{"type":"object","properties":{"rotationInterval":{"type":"integer","minimum":1,"maximum":365,"description":"The interval in days between credential rotations."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"integer","minimum":0,"maximum":23,"description":"The hour (0-23) at which to rotate (UTC timezone)."},"minutes":{"type":"integer","minimum":0,"maximum":59,"description":"The minute (0-59) at which to rotate (UTC timezone)."}},"required":["hours","minutes"],"additionalProperties":false}},"required":["rotationInterval","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration for the Azure Client Secrets Connection."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"clientId":{"type":"string"}},"required":["tenantId","clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Certificate)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-client-secrets/available":{"get":{"operationId":"listAzureClientSecretsAvailableAppConnections","tags":["App Connections"],"description":"List the Azure Client Secrets Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Azure Client Secrets Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["azure-client-secrets"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-client-secrets/{connectionId}":{"get":{"operationId":"getAzureClientSecretsAppConnection","tags":["App Connections"],"description":"Get the specified Azure Client Secrets Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure Client Secrets Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"clientId":{"type":"string"}},"required":["tenantId","clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Certificate)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAzureClientSecretsAppConnection","tags":["App Connections"],"description":"Update the specified Azure Client Secrets Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1,"description":"The OAuth code to use to connect with Azure Client Secrets."},"tenantId":{"type":"string","minLength":1,"description":"The Tenant ID to use to connect with Azure Client Secrets."}},"required":["code","tenantId"],"additionalProperties":false},{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","minLength":1,"maxLength":50,"description":"The Client ID to use to connect with Azure Client Secrets."},"clientSecret":{"type":"string","minLength":1,"maxLength":50,"description":"The Client Secret to use to connect with Azure Client Secrets."},"tenantId":{"type":"string","format":"uuid","minLength":1,"description":"The Tenant ID to use to connect with Azure Client Secrets."},"clientSecretKeyId":{"type":"string","format":"uuid","description":"The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked."}},"required":["clientId","clientSecret","tenantId"],"additionalProperties":false},{"type":"object","properties":{"tenantId":{"type":"string","format":"uuid","minLength":1,"description":"The Tenant ID to use to connect with Azure Client Secrets."},"clientId":{"type":"string","format":"uuid","minLength":1,"description":"The Client ID to use to connect with Azure Client Secrets."},"certificateBody":{"type":"string","minLength":1,"description":"The certificate body in PEM format to use to connect with Azure Client Secrets."},"privateKey":{"type":"string","minLength":1,"description":"The private key to use to connect with Azure Client Secrets. This is never transmitted to Azure and is only used to sign the Azure client assertion with."}},"required":["tenantId","clientId","certificateBody","privateKey"],"additionalProperties":false}],"description":"The credentials used to connect with Azure Client Secrets."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Azure Client Secrets Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Azure Client Secrets Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Azure Client Secrets Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure Client Secrets Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure Client Secrets Connections."},"isAutoRotationEnabled":{"type":"boolean","description":"Whether or not automatic credential rotation is enabled for the Azure Client Secrets Connection."},"rotation":{"type":"object","properties":{"rotationInterval":{"type":"integer","minimum":1,"maximum":365,"description":"The interval in days between credential rotations."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"integer","minimum":0,"maximum":23,"description":"The hour (0-23) at which to rotate (UTC timezone)."},"minutes":{"type":"integer","minimum":0,"maximum":59,"description":"The minute (0-59) at which to rotate (UTC timezone)."}},"required":["hours","minutes"],"additionalProperties":false}},"additionalProperties":false,"description":"The updated credential rotation configuration for the Azure Client Secrets Connection."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure Client Secrets Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"clientId":{"type":"string"}},"required":["tenantId","clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Certificate)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAzureClientSecretsAppConnection","tags":["App Connections"],"description":"Delete the specified Azure Client Secrets Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure Client Secrets Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"clientId":{"type":"string"}},"required":["tenantId","clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Certificate)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-client-secrets/connection-name/{connectionName}":{"get":{"operationId":"getAzureClientSecretsAppConnectionByName","tags":["App Connections"],"description":"Get the specified Azure Client Secrets Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Azure Client Secrets Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Azure Client Secrets Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"clientId":{"type":"string"}},"required":["tenantId","clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Certificate)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-client-secrets/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateAzureClientSecretsAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Azure Client Secrets Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure Client Secrets Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"}},"required":["tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"}},"required":["clientId","tenantId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Client Secret)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-client-secrets"]},"method":{"type":"string","enum":["certificate"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"clientId":{"type":"string"}},"required":["tenantId","clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure Client Secrets (Certificate)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-devops":{"get":{"operationId":"listAzureDevopsAppConnections","tags":["App Connections"],"description":"List the Azure DevOps Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Azure DevOps Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"orgName":{"type":"string"}},"required":["orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["clientId","tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Client Secret)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAzureDevopsAppConnection","tags":["App Connections"],"description":"Create an Azure DevOps Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["oauth"],"description":"The method used to authenticate with Azure DevOps."},"credentials":{"type":"object","properties":{"code":{"type":"string","minLength":1,"description":"The OAuth code to use to connect with Azure DevOps."},"tenantId":{"type":"string","minLength":1,"description":"The Tenant ID to use to connect with Azure DevOps."},"orgName":{"type":"string","minLength":1,"description":"The Organization name to use to connect with Azure DevOps."}},"required":["code","tenantId","orgName"],"additionalProperties":false,"description":"The credentials used to connect with Azure DevOps."}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["access-token"],"description":"The method used to authenticate with Azure DevOps."},"credentials":{"type":"object","properties":{"accessToken":{"type":"string","minLength":1},"orgName":{"type":"string","minLength":1}},"required":["accessToken","orgName"],"additionalProperties":false,"description":"The credentials used to connect with Azure DevOps."}},"required":["method","credentials"],"additionalProperties":false},{"type":"object","properties":{"method":{"type":"string","enum":["client-secret"],"description":"The method used to authenticate with Azure DevOps."},"credentials":{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","minLength":1,"maxLength":50,"description":"The Client ID to use to connect with Azure Client Secrets."},"clientSecret":{"type":"string","minLength":1,"maxLength":50,"description":"The Client Secret to use to connect with Azure Client Secrets."},"tenantId":{"type":"string","format":"uuid","minLength":1,"description":"The Tenant ID to use to connect with Azure DevOps."},"orgName":{"type":"string","minLength":1,"description":"The Organization name to use to connect with Azure DevOps."},"clientSecretKeyId":{"type":"string","format":"uuid","description":"The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked."}},"required":["clientId","clientSecret","tenantId","orgName"],"additionalProperties":false,"description":"The credentials used to connect with Azure DevOps."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Azure DevOps Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Azure DevOps Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Azure DevOps Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Azure DevOps Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure DevOps Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure DevOps Connections."},"isAutoRotationEnabled":{"type":"boolean","description":"Whether or not automatic credential rotation is enabled for the Azure DevOps Connection."},"rotation":{"type":"object","properties":{"rotationInterval":{"type":"integer","minimum":1,"maximum":365,"description":"The interval in days between credential rotations."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"integer","minimum":0,"maximum":23,"description":"The hour (0-23) at which to rotate (UTC timezone)."},"minutes":{"type":"integer","minimum":0,"maximum":59,"description":"The minute (0-59) at which to rotate (UTC timezone)."}},"required":["hours","minutes"],"additionalProperties":false}},"required":["rotationInterval","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration for the Azure DevOps Connection."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"orgName":{"type":"string"}},"required":["orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["clientId","tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-devops/available":{"get":{"operationId":"listAzureDevopsAvailableAppConnections","tags":["App Connections"],"description":"List the Azure DevOps Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Azure DevOps Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["azure-devops"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-devops/{connectionId}":{"get":{"operationId":"getAzureDevopsAppConnection","tags":["App Connections"],"description":"Get the specified Azure DevOps Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure DevOps Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"orgName":{"type":"string"}},"required":["orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["clientId","tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAzureDevopsAppConnection","tags":["App Connections"],"description":"Update the specified Azure DevOps Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1,"description":"The OAuth code to use to connect with Azure DevOps."},"tenantId":{"type":"string","minLength":1,"description":"The Tenant ID to use to connect with Azure DevOps."},"orgName":{"type":"string","minLength":1,"description":"The Organization name to use to connect with Azure DevOps."}},"required":["code","tenantId","orgName"],"additionalProperties":false},{"type":"object","properties":{"accessToken":{"type":"string","minLength":1},"orgName":{"type":"string","minLength":1}},"required":["accessToken","orgName"],"additionalProperties":false},{"type":"object","properties":{"clientId":{"type":"string","format":"uuid","minLength":1,"maxLength":50,"description":"The Client ID to use to connect with Azure Client Secrets."},"clientSecret":{"type":"string","minLength":1,"maxLength":50,"description":"The Client Secret to use to connect with Azure Client Secrets."},"tenantId":{"type":"string","format":"uuid","minLength":1,"description":"The Tenant ID to use to connect with Azure DevOps."},"orgName":{"type":"string","minLength":1,"description":"The Organization name to use to connect with Azure DevOps."},"clientSecretKeyId":{"type":"string","format":"uuid","description":"The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked."}},"required":["clientId","clientSecret","tenantId","orgName"],"additionalProperties":false}],"description":"The credentials used to connect with Azure DevOps."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Azure DevOps Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Azure DevOps Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Azure DevOps Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure DevOps Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure DevOps Connections."},"isAutoRotationEnabled":{"type":"boolean","description":"Whether or not automatic credential rotation is enabled for the Azure DevOps Connection."},"rotation":{"type":"object","properties":{"rotationInterval":{"type":"integer","minimum":1,"maximum":365,"description":"The interval in days between credential rotations."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"integer","minimum":0,"maximum":23,"description":"The hour (0-23) at which to rotate (UTC timezone)."},"minutes":{"type":"integer","minimum":0,"maximum":59,"description":"The minute (0-59) at which to rotate (UTC timezone)."}},"required":["hours","minutes"],"additionalProperties":false}},"additionalProperties":false,"description":"The updated credential rotation configuration for the Azure DevOps Connection."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure DevOps Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"orgName":{"type":"string"}},"required":["orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["clientId","tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAzureDevopsAppConnection","tags":["App Connections"],"description":"Delete the specified Azure DevOps Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure DevOps Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"orgName":{"type":"string"}},"required":["orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["clientId","tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-devops/connection-name/{connectionName}":{"get":{"operationId":"getAzureDevopsAppConnectionByName","tags":["App Connections"],"description":"Get the specified Azure DevOps Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Azure DevOps Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Azure DevOps Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"orgName":{"type":"string"}},"required":["orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["clientId","tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-devops/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateAzureDevopsAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Azure DevOps Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure DevOps Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["oauth"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (OAuth)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"orgName":{"type":"string"}},"required":["orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Access Token)"},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-devops"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string"},"tenantId":{"type":"string"},"orgName":{"type":"string"}},"required":["clientId","tenantId","orgName"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DevOps (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-adcs":{"get":{"operationId":"listAzureAdcsAppConnections","tags":["App Connections"],"description":"List the Azure ADCS (Web Enrollment) Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Azure ADCS (Web Enrollment) Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"username":{"type":"string","minLength":1,"maxLength":255,"description":"The username used to access Azure ADCS (format: 'DOMAIN\\username' or 'username@domain.com')."},"adcsUrl":{"type":"string","minLength":1,"maxLength":255,"description":"The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv')."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate (PEM format) to use for secure connection."}},"required":["username","adcsUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure ADCS (Web Enrollment) (Username and Password)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAzureAdcsAppConnection","tags":["App Connections"],"description":"Create an Azure ADCS (Web Enrollment) Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["username-password"],"description":"The method used to authenticate with Azure ADCS (Web Enrollment)."},"credentials":{"type":"object","properties":{"adcsUrl":{"type":"string","minLength":1,"maxLength":255,"description":"The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv')."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"The username used to access Azure ADCS (format: 'DOMAIN\\username' or 'username@domain.com')."},"password":{"type":"string","minLength":1,"maxLength":255,"description":"The password used to access Azure ADCS."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate (PEM format) to use for secure connection."}},"required":["adcsUrl","username","password"],"additionalProperties":false,"description":"The credentials used to connect with Azure ADCS (Web Enrollment)."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Azure ADCS (Web Enrollment) Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Azure ADCS (Web Enrollment) Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Azure ADCS (Web Enrollment) Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Azure ADCS (Web Enrollment) Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure ADCS (Web Enrollment) Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure ADCS (Web Enrollment) Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Azure ADCS (Web Enrollment) Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure ADCS (Web Enrollment) Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"username":{"type":"string","minLength":1,"maxLength":255,"description":"The username used to access Azure ADCS (format: 'DOMAIN\\username' or 'username@domain.com')."},"adcsUrl":{"type":"string","minLength":1,"maxLength":255,"description":"The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv')."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate (PEM format) to use for secure connection."}},"required":["username","adcsUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure ADCS (Web Enrollment) (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-adcs/available":{"get":{"operationId":"listAzureAdcsAvailableAppConnections","tags":["App Connections"],"description":"List the Azure ADCS (Web Enrollment) Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Azure ADCS (Web Enrollment) Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["azure-adcs"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-adcs/{connectionId}":{"get":{"operationId":"getAzureAdcsAppConnection","tags":["App Connections"],"description":"Get the specified Azure ADCS (Web Enrollment) Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure ADCS (Web Enrollment) Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"username":{"type":"string","minLength":1,"maxLength":255,"description":"The username used to access Azure ADCS (format: 'DOMAIN\\username' or 'username@domain.com')."},"adcsUrl":{"type":"string","minLength":1,"maxLength":255,"description":"The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv')."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate (PEM format) to use for secure connection."}},"required":["username","adcsUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure ADCS (Web Enrollment) (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAzureAdcsAppConnection","tags":["App Connections"],"description":"Update the specified Azure ADCS (Web Enrollment) Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"adcsUrl":{"type":"string","minLength":1,"maxLength":255,"description":"The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv')."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"The username used to access Azure ADCS (format: 'DOMAIN\\username' or 'username@domain.com')."},"password":{"type":"string","minLength":1,"maxLength":255,"description":"The password used to access Azure ADCS."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate (PEM format) to use for secure connection."}},"required":["adcsUrl","username","password"],"additionalProperties":false,"description":"The credentials used to connect with Azure ADCS (Web Enrollment)."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Azure ADCS (Web Enrollment) Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Azure ADCS (Web Enrollment) Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Azure ADCS (Web Enrollment) Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure ADCS (Web Enrollment) Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure ADCS (Web Enrollment) Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Azure ADCS (Web Enrollment) Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure ADCS (Web Enrollment) Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure ADCS (Web Enrollment) Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"username":{"type":"string","minLength":1,"maxLength":255,"description":"The username used to access Azure ADCS (format: 'DOMAIN\\username' or 'username@domain.com')."},"adcsUrl":{"type":"string","minLength":1,"maxLength":255,"description":"The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv')."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate (PEM format) to use for secure connection."}},"required":["username","adcsUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure ADCS (Web Enrollment) (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAzureAdcsAppConnection","tags":["App Connections"],"description":"Delete the specified Azure ADCS (Web Enrollment) Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure ADCS (Web Enrollment) Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"username":{"type":"string","minLength":1,"maxLength":255,"description":"The username used to access Azure ADCS (format: 'DOMAIN\\username' or 'username@domain.com')."},"adcsUrl":{"type":"string","minLength":1,"maxLength":255,"description":"The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv')."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate (PEM format) to use for secure connection."}},"required":["username","adcsUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure ADCS (Web Enrollment) (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-adcs/connection-name/{connectionName}":{"get":{"operationId":"getAzureAdcsAppConnectionByName","tags":["App Connections"],"description":"Get the specified Azure ADCS (Web Enrollment) Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Azure ADCS (Web Enrollment) Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Azure ADCS (Web Enrollment) Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"username":{"type":"string","minLength":1,"maxLength":255,"description":"The username used to access Azure ADCS (format: 'DOMAIN\\username' or 'username@domain.com')."},"adcsUrl":{"type":"string","minLength":1,"maxLength":255,"description":"The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv')."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate (PEM format) to use for secure connection."}},"required":["username","adcsUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure ADCS (Web Enrollment) (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-adcs/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateAzureAdcsAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Azure ADCS (Web Enrollment) Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure ADCS (Web Enrollment) Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"username":{"type":"string","minLength":1,"maxLength":255,"description":"The username used to access Azure ADCS (format: 'DOMAIN\\username' or 'username@domain.com')."},"adcsUrl":{"type":"string","minLength":1,"maxLength":255,"description":"The HTTPS URL of the Azure ADCS instance to connect with (e.g., 'https://adcs.yourdomain.com/certsrv')."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates (true/false). Set to false only in test environments with self-signed certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate (PEM format) to use for secure connection."}},"required":["username","adcsUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure ADCS (Web Enrollment) (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/adcs":{"get":{"operationId":"listAdcsAppConnections","tags":["App Connections"],"description":"List the Microsoft ADCS Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Microsoft ADCS Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":255,"description":"The AD CS server's DNS name (FQDN), for example ca01.corp.example.com."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"Windows login: DOMAIN\\user or user@domain."}},"required":["host","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft ADCS (Username and Password)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAdcsAppConnection","tags":["App Connections"],"description":"Create a Microsoft ADCS Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":255,"description":"The AD CS server's DNS name (FQDN), for example ca01.corp.example.com."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"Windows login: DOMAIN\\user or user@domain."},"password":{"type":"string","minLength":1,"maxLength":255,"description":"The account password."}},"required":["host","username","password"],"additionalProperties":false}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Microsoft ADCS Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Microsoft ADCS Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Microsoft ADCS Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Microsoft ADCS Connections."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Microsoft ADCS Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Microsoft ADCS Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":255,"description":"The AD CS server's DNS name (FQDN), for example ca01.corp.example.com."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"Windows login: DOMAIN\\user or user@domain."}},"required":["host","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft ADCS (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/adcs/available":{"get":{"operationId":"listAdcsAvailableAppConnections","tags":["App Connections"],"description":"List the Microsoft ADCS Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Microsoft ADCS Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["adcs"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/adcs/{connectionId}":{"get":{"operationId":"getAdcsAppConnection","tags":["App Connections"],"description":"Get the specified Microsoft ADCS Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Microsoft ADCS Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":255,"description":"The AD CS server's DNS name (FQDN), for example ca01.corp.example.com."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"Windows login: DOMAIN\\user or user@domain."}},"required":["host","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft ADCS (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAdcsAppConnection","tags":["App Connections"],"description":"Update the specified Microsoft ADCS Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":255,"description":"The AD CS server's DNS name (FQDN), for example ca01.corp.example.com."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"Windows login: DOMAIN\\user or user@domain."},"password":{"type":"string","minLength":1,"maxLength":255,"description":"The account password."}},"required":["host","username","password"],"additionalProperties":false}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Microsoft ADCS Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Microsoft ADCS Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Microsoft ADCS Connections."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Microsoft ADCS Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Microsoft ADCS Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Microsoft ADCS Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":255,"description":"The AD CS server's DNS name (FQDN), for example ca01.corp.example.com."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"Windows login: DOMAIN\\user or user@domain."}},"required":["host","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft ADCS (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAdcsAppConnection","tags":["App Connections"],"description":"Delete the specified Microsoft ADCS Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Microsoft ADCS Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":255,"description":"The AD CS server's DNS name (FQDN), for example ca01.corp.example.com."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"Windows login: DOMAIN\\user or user@domain."}},"required":["host","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft ADCS (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/adcs/connection-name/{connectionName}":{"get":{"operationId":"getAdcsAppConnectionByName","tags":["App Connections"],"description":"Get the specified Microsoft ADCS Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Microsoft ADCS Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Microsoft ADCS Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":255,"description":"The AD CS server's DNS name (FQDN), for example ca01.corp.example.com."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"Windows login: DOMAIN\\user or user@domain."}},"required":["host","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft ADCS (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/adcs/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateAdcsAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Microsoft ADCS Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Microsoft ADCS Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["adcs"]},"method":{"type":"string","enum":["username-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"maxLength":255,"description":"The AD CS server's DNS name (FQDN), for example ca01.corp.example.com."},"username":{"type":"string","minLength":1,"maxLength":255,"description":"Windows login: DOMAIN\\user or user@domain."}},"required":["host","username"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft ADCS (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-dns":{"get":{"operationId":"listAzureDnsAppConnections","tags":["App Connections"],"description":"List the Azure DNS Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Azure DNS Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-dns"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant ID must be a valid GUID"},"subscriptionId":{"type":"string","description":"Subscription ID must be a valid GUID"}},"required":["tenantId","subscriptionId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DNS (Client Secret)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAzureDnsAppConnection","tags":["App Connections"],"description":"Create an Azure DNS Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["client-secret"],"description":"The method used to authenticate with Azure DNS."},"credentials":{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant ID must be a valid GUID"},"clientId":{"type":"string","description":"Client ID must be a valid GUID"},"clientSecret":{"type":"string","minLength":1,"maxLength":256},"subscriptionId":{"type":"string","description":"Subscription ID must be a valid GUID"},"clientSecretKeyId":{"type":"string","description":"The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked."}},"required":["tenantId","clientId","clientSecret","subscriptionId"],"additionalProperties":false,"description":"The credentials used to connect with Azure DNS."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Azure DNS Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Azure DNS Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Azure DNS Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Azure DNS Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure DNS Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure DNS Connections."},"isAutoRotationEnabled":{"type":"boolean","description":"Whether or not automatic credential rotation is enabled for the Azure DNS Connection."},"rotation":{"type":"object","properties":{"rotationInterval":{"type":"integer","minimum":1,"maximum":365,"description":"The interval in days between credential rotations."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"integer","minimum":0,"maximum":23,"description":"The hour (0-23) at which to rotate (UTC timezone)."},"minutes":{"type":"integer","minimum":0,"maximum":59,"description":"The minute (0-59) at which to rotate (UTC timezone)."}},"required":["hours","minutes"],"additionalProperties":false}},"required":["rotationInterval","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration for the Azure DNS Connection."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-dns"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant ID must be a valid GUID"},"subscriptionId":{"type":"string","description":"Subscription ID must be a valid GUID"}},"required":["tenantId","subscriptionId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DNS (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-dns/available":{"get":{"operationId":"listAzureDnsAvailableAppConnections","tags":["App Connections"],"description":"List the Azure DNS Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Azure DNS Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["azure-dns"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-dns/{connectionId}":{"get":{"operationId":"getAzureDnsAppConnection","tags":["App Connections"],"description":"Get the specified Azure DNS Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure DNS Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-dns"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant ID must be a valid GUID"},"subscriptionId":{"type":"string","description":"Subscription ID must be a valid GUID"}},"required":["tenantId","subscriptionId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DNS (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAzureDnsAppConnection","tags":["App Connections"],"description":"Update the specified Azure DNS Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant ID must be a valid GUID"},"clientId":{"type":"string","description":"Client ID must be a valid GUID"},"clientSecret":{"type":"string","minLength":1,"maxLength":256},"subscriptionId":{"type":"string","description":"Subscription ID must be a valid GUID"},"clientSecretKeyId":{"type":"string","description":"The Key ID of the client secret in Azure AD. Required when enabling credential rotation so the original secret can be revoked."}},"required":["tenantId","clientId","clientSecret","subscriptionId"],"additionalProperties":false,"description":"The credentials used to connect with Azure DNS."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Azure DNS Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Azure DNS Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Azure DNS Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure DNS Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Azure DNS Connections."},"isAutoRotationEnabled":{"type":"boolean","description":"Whether or not automatic credential rotation is enabled for the Azure DNS Connection."},"rotation":{"type":"object","properties":{"rotationInterval":{"type":"integer","minimum":1,"maximum":365,"description":"The interval in days between credential rotations."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"integer","minimum":0,"maximum":23,"description":"The hour (0-23) at which to rotate (UTC timezone)."},"minutes":{"type":"integer","minimum":0,"maximum":59,"description":"The minute (0-59) at which to rotate (UTC timezone)."}},"required":["hours","minutes"],"additionalProperties":false}},"additionalProperties":false,"description":"The updated credential rotation configuration for the Azure DNS Connection."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure DNS Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-dns"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant ID must be a valid GUID"},"subscriptionId":{"type":"string","description":"Subscription ID must be a valid GUID"}},"required":["tenantId","subscriptionId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DNS (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAzureDnsAppConnection","tags":["App Connections"],"description":"Delete the specified Azure DNS Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure DNS Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-dns"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant ID must be a valid GUID"},"subscriptionId":{"type":"string","description":"Subscription ID must be a valid GUID"}},"required":["tenantId","subscriptionId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DNS (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-dns/connection-name/{connectionName}":{"get":{"operationId":"getAzureDnsAppConnectionByName","tags":["App Connections"],"description":"Get the specified Azure DNS Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Azure DNS Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Azure DNS Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-dns"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant ID must be a valid GUID"},"subscriptionId":{"type":"string","description":"Subscription ID must be a valid GUID"}},"required":["tenantId","subscriptionId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DNS (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/azure-dns/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateAzureDnsAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Azure DNS Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Azure DNS Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["azure-dns"]},"method":{"type":"string","enum":["client-secret"]},"credentials":{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant ID must be a valid GUID"},"subscriptionId":{"type":"string","description":"Subscription ID must be a valid GUID"}},"required":["tenantId","subscriptionId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Azure DNS (Client Secret)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/databricks":{"get":{"operationId":"listDatabricksAppConnections","tags":["App Connections"],"description":"List the Databricks Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Databricks Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["databricks"]},"method":{"type":"string","enum":["service-principal"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1},"workspaceUrl":{"type":"string","format":"uri","minLength":1}},"required":["clientId","workspaceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Databricks (Service Principal)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createDatabricksAppConnection","tags":["App Connections"],"description":"Create a Databricks Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["service-principal"],"description":"The method used to authenticate with Databricks."},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1},"clientSecret":{"type":"string","minLength":1},"workspaceUrl":{"type":"string","format":"uri","minLength":1}},"required":["clientId","clientSecret","workspaceUrl"],"additionalProperties":false,"description":"The credentials used to connect with Databricks."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Databricks Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Databricks Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Databricks Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Databricks Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Databricks Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Databricks Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Databricks Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Databricks Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["databricks"]},"method":{"type":"string","enum":["service-principal"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1},"workspaceUrl":{"type":"string","format":"uri","minLength":1}},"required":["clientId","workspaceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Databricks (Service Principal)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/databricks/available":{"get":{"operationId":"listDatabricksAvailableAppConnections","tags":["App Connections"],"description":"List the Databricks Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Databricks Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["databricks"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/databricks/{connectionId}":{"get":{"operationId":"getDatabricksAppConnection","tags":["App Connections"],"description":"Get the specified Databricks Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Databricks Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["databricks"]},"method":{"type":"string","enum":["service-principal"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1},"workspaceUrl":{"type":"string","format":"uri","minLength":1}},"required":["clientId","workspaceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Databricks (Service Principal)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateDatabricksAppConnection","tags":["App Connections"],"description":"Update the specified Databricks Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1},"clientSecret":{"type":"string","minLength":1},"workspaceUrl":{"type":"string","format":"uri","minLength":1}},"required":["clientId","clientSecret","workspaceUrl"],"additionalProperties":false,"description":"The credentials used to connect with Databricks."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Databricks Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Databricks Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Databricks Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Databricks Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Databricks Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Databricks Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Databricks Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Databricks Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["databricks"]},"method":{"type":"string","enum":["service-principal"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1},"workspaceUrl":{"type":"string","format":"uri","minLength":1}},"required":["clientId","workspaceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Databricks (Service Principal)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteDatabricksAppConnection","tags":["App Connections"],"description":"Delete the specified Databricks Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Databricks Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["databricks"]},"method":{"type":"string","enum":["service-principal"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1},"workspaceUrl":{"type":"string","format":"uri","minLength":1}},"required":["clientId","workspaceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Databricks (Service Principal)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/databricks/connection-name/{connectionName}":{"get":{"operationId":"getDatabricksAppConnectionByName","tags":["App Connections"],"description":"Get the specified Databricks Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Databricks Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Databricks Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["databricks"]},"method":{"type":"string","enum":["service-principal"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1},"workspaceUrl":{"type":"string","format":"uri","minLength":1}},"required":["clientId","workspaceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Databricks (Service Principal)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/databricks/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateDatabricksAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Databricks Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Databricks Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["databricks"]},"method":{"type":"string","enum":["service-principal"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1},"workspaceUrl":{"type":"string","format":"uri","minLength":1}},"required":["clientId","workspaceUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Databricks (Service Principal)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/humanitec":{"get":{"operationId":"listHumanitecAppConnections","tags":["App Connections"],"description":"List the Humanitec Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Humanitec Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["humanitec"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Humanitec (API Token)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createHumanitecAppConnection","tags":["App Connections"],"description":"Create a Humanitec Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["api-token"],"description":"The method used to authenticate with Humanitec."},"credentials":{"type":"object","properties":{"apiToken":{"type":"string","minLength":1}},"required":["apiToken"],"additionalProperties":false,"description":"The credentials used to connect with Humanitec."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Humanitec Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Humanitec Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Humanitec Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Humanitec Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Humanitec Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Humanitec Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Humanitec Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Humanitec Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["humanitec"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Humanitec (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/humanitec/available":{"get":{"operationId":"listHumanitecAvailableAppConnections","tags":["App Connections"],"description":"List the Humanitec Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Humanitec Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["humanitec"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/humanitec/{connectionId}":{"get":{"operationId":"getHumanitecAppConnection","tags":["App Connections"],"description":"Get the specified Humanitec Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Humanitec Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["humanitec"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Humanitec (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateHumanitecAppConnection","tags":["App Connections"],"description":"Update the specified Humanitec Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"apiToken":{"type":"string","minLength":1}},"required":["apiToken"],"additionalProperties":false,"description":"The credentials used to connect with Humanitec."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Humanitec Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Humanitec Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Humanitec Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Humanitec Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Humanitec Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Humanitec Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Humanitec Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Humanitec Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["humanitec"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Humanitec (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteHumanitecAppConnection","tags":["App Connections"],"description":"Delete the specified Humanitec Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Humanitec Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["humanitec"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Humanitec (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/humanitec/connection-name/{connectionName}":{"get":{"operationId":"getHumanitecAppConnectionByName","tags":["App Connections"],"description":"Get the specified Humanitec Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Humanitec Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Humanitec Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["humanitec"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Humanitec (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/humanitec/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateHumanitecAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Humanitec Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Humanitec Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["humanitec"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Humanitec (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/terraform-cloud":{"get":{"operationId":"listTerraformCloudAppConnections","tags":["App Connections"],"description":"List the Terraform Cloud Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Terraform Cloud Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["terraform-cloud"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Terraform Cloud (API Token)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createTerraformCloudAppConnection","tags":["App Connections"],"description":"Create a Terraform Cloud Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["api-token"],"description":"The method used to authenticate with Terraform Cloud."},"credentials":{"type":"object","properties":{"apiToken":{"type":"string","minLength":1,"description":"The API token to use to connect with Terraform Cloud."}},"required":["apiToken"],"additionalProperties":false,"description":"The credentials used to connect with Terraform Cloud."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Terraform Cloud Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Terraform Cloud Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Terraform Cloud Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Terraform Cloud Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Terraform Cloud Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Terraform Cloud Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Terraform Cloud Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Terraform Cloud Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["terraform-cloud"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Terraform Cloud (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/terraform-cloud/available":{"get":{"operationId":"listTerraformCloudAvailableAppConnections","tags":["App Connections"],"description":"List the Terraform Cloud Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Terraform Cloud Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["terraform-cloud"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/terraform-cloud/{connectionId}":{"get":{"operationId":"getTerraformCloudAppConnection","tags":["App Connections"],"description":"Get the specified Terraform Cloud Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Terraform Cloud Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["terraform-cloud"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Terraform Cloud (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateTerraformCloudAppConnection","tags":["App Connections"],"description":"Update the specified Terraform Cloud Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"apiToken":{"type":"string","minLength":1,"description":"The API token to use to connect with Terraform Cloud."}},"required":["apiToken"],"additionalProperties":false,"description":"The credentials used to connect with Terraform Cloud."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Terraform Cloud Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Terraform Cloud Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Terraform Cloud Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Terraform Cloud Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Terraform Cloud Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Terraform Cloud Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Terraform Cloud Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Terraform Cloud Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["terraform-cloud"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Terraform Cloud (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteTerraformCloudAppConnection","tags":["App Connections"],"description":"Delete the specified Terraform Cloud Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Terraform Cloud Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["terraform-cloud"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Terraform Cloud (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/terraform-cloud/connection-name/{connectionName}":{"get":{"operationId":"getTerraformCloudAppConnectionByName","tags":["App Connections"],"description":"Get the specified Terraform Cloud Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Terraform Cloud Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Terraform Cloud Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["terraform-cloud"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Terraform Cloud (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/terraform-cloud/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateTerraformCloudAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Terraform Cloud Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Terraform Cloud Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["terraform-cloud"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Terraform Cloud (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/vercel":{"get":{"operationId":"listVercelAppConnections","tags":["App Connections"],"description":"List the Vercel Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Vercel Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["vercel"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Vercel (API Token)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createVercelAppConnection","tags":["App Connections"],"description":"Create a Vercel Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["api-token"],"description":"The method used to authenticate with Vercel."},"credentials":{"type":"object","properties":{"apiToken":{"type":"string","minLength":1,"description":"The API token used to authenticate with Vercel."}},"required":["apiToken"],"additionalProperties":false,"description":"The credentials used to connect with Vercel."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Vercel Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Vercel Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Vercel Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Vercel Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Vercel Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Vercel Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Vercel Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Vercel Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["vercel"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Vercel (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/vercel/available":{"get":{"operationId":"listVercelAvailableAppConnections","tags":["App Connections"],"description":"List the Vercel Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Vercel Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["vercel"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/vercel/{connectionId}":{"get":{"operationId":"getVercelAppConnection","tags":["App Connections"],"description":"Get the specified Vercel Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Vercel Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["vercel"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Vercel (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateVercelAppConnection","tags":["App Connections"],"description":"Update the specified Vercel Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"apiToken":{"type":"string","minLength":1,"description":"The API token used to authenticate with Vercel."}},"required":["apiToken"],"additionalProperties":false,"description":"The credentials used to connect with Vercel."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Vercel Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Vercel Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Vercel Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Vercel Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Vercel Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Vercel Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Vercel Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Vercel Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["vercel"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Vercel (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteVercelAppConnection","tags":["App Connections"],"description":"Delete the specified Vercel Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Vercel Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["vercel"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Vercel (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/vercel/connection-name/{connectionName}":{"get":{"operationId":"getVercelAppConnectionByName","tags":["App Connections"],"description":"Get the specified Vercel Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Vercel Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Vercel Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["vercel"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Vercel (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/vercel/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateVercelAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Vercel Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Vercel Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["vercel"]},"method":{"type":"string","enum":["api-token"]},"credentials":{"type":"object","properties":{},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Vercel (API Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/postgres":{"get":{"operationId":"listPostgresAppConnections","tags":["App Connections"],"description":"List the PostgreSQL Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list PostgreSQL Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["postgres"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PostgreSQL (Username and Password)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPostgresAppConnection","tags":["App Connections"],"description":"Create a PostgreSQL Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["username-and-password"],"description":"The method used to authenticate with PostgreSQL."},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"port":{"type":"number","description":"The port number of the database."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"password":{"type":"string","minLength":1,"description":"The password to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","port","database","username","password","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false,"description":"The credentials used to connect with PostgreSQL."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the PostgreSQL Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the PostgreSQL Connection."},"projectId":{"type":"string","description":"The ID of the project to create the PostgreSQL Connection in."},"isPlatformManagedCredentials":{"type":"boolean","default":false,"description":"Whether or not the PostgreSQL Connection credentials should be managed by Infisical. Once enabled this cannot be reversed."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for PostgreSQL Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for PostgreSQL Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["postgres"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PostgreSQL (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/postgres/available":{"get":{"operationId":"listPostgresAvailableAppConnections","tags":["App Connections"],"description":"List the PostgreSQL Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list PostgreSQL Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["postgres"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/postgres/{connectionId}":{"get":{"operationId":"getPostgresAppConnection","tags":["App Connections"],"description":"Get the specified PostgreSQL Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the PostgreSQL Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["postgres"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PostgreSQL (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePostgresAppConnection","tags":["App Connections"],"description":"Update the specified PostgreSQL Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"port":{"type":"number","description":"The port number of the database."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"password":{"type":"string","minLength":1,"description":"The password to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","port","database","username","password","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false,"description":"The credentials used to connect with PostgreSQL."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the PostgreSQL Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the PostgreSQL Connection."},"isPlatformManagedCredentials":{"type":"boolean","description":"Whether or not the PostgreSQL Connection credentials should be managed by Infisical. Once enabled this cannot be reversed."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for PostgreSQL Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for PostgreSQL Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the PostgreSQL Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["postgres"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PostgreSQL (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deletePostgresAppConnection","tags":["App Connections"],"description":"Delete the specified PostgreSQL Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the PostgreSQL Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["postgres"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PostgreSQL (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/postgres/connection-name/{connectionName}":{"get":{"operationId":"getPostgresAppConnectionByName","tags":["App Connections"],"description":"Get the specified PostgreSQL Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the PostgreSQL Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the PostgreSQL Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["postgres"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PostgreSQL (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/postgres/{connectionId}/rotate-credentials":{"post":{"operationId":"rotatePostgresAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified PostgreSQL Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the PostgreSQL Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["postgres"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PostgreSQL (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/powerdns":{"get":{"operationId":"listPowerdnsAppConnections","tags":["App Connections"],"description":"List the PowerDNS Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list PowerDNS Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["powerdns"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"apiUrl":{"type":"string","format":"uri","maxLength":512,"description":"The base URL of the PowerDNS web server, excluding the /api/v1 path."},"serverId":{"type":"string","maxLength":64,"description":"The PowerDNS API server ID. Leave unset unless you connect through a proxy fronting several servers; the Authoritative Server always reports 'localhost'."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether to reject PowerDNS TLS certificates that are not trusted. Defaults to true."},"sslCertificate":{"type":"string","maxLength":8192,"description":"A PEM-encoded CA certificate to trust when connecting to PowerDNS over HTTPS."}},"required":["apiUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PowerDNS (API Key)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createPowerdnsAppConnection","tags":["App Connections"],"description":"Create a PowerDNS Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["api-key"],"description":"The method used to authenticate with PowerDNS."},"credentials":{"type":"object","properties":{"apiUrl":{"type":"string","format":"uri","maxLength":512,"description":"The base URL of the PowerDNS web server, excluding the /api/v1 path."},"apiKey":{"type":"string","minLength":1,"maxLength":512,"description":"The value of the PowerDNS api-key setting."},"serverId":{"type":"string","maxLength":64,"description":"The PowerDNS API server ID. Leave unset unless you connect through a proxy fronting several servers; the Authoritative Server always reports 'localhost'."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether to reject PowerDNS TLS certificates that are not trusted. Defaults to true."},"sslCertificate":{"type":"string","maxLength":8192,"description":"A PEM-encoded CA certificate to trust when connecting to PowerDNS over HTTPS."}},"required":["apiUrl","apiKey"],"additionalProperties":false,"description":"The credentials used to connect with PowerDNS."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the PowerDNS Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the PowerDNS Connection."},"projectId":{"type":"string","description":"The ID of the project to create the PowerDNS Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for PowerDNS Connections."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for PowerDNS Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for PowerDNS Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["powerdns"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"apiUrl":{"type":"string","format":"uri","maxLength":512,"description":"The base URL of the PowerDNS web server, excluding the /api/v1 path."},"serverId":{"type":"string","maxLength":64,"description":"The PowerDNS API server ID. Leave unset unless you connect through a proxy fronting several servers; the Authoritative Server always reports 'localhost'."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether to reject PowerDNS TLS certificates that are not trusted. Defaults to true."},"sslCertificate":{"type":"string","maxLength":8192,"description":"A PEM-encoded CA certificate to trust when connecting to PowerDNS over HTTPS."}},"required":["apiUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PowerDNS (API Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/powerdns/available":{"get":{"operationId":"listPowerdnsAvailableAppConnections","tags":["App Connections"],"description":"List the PowerDNS Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list PowerDNS Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["powerdns"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/powerdns/{connectionId}":{"get":{"operationId":"getPowerdnsAppConnection","tags":["App Connections"],"description":"Get the specified PowerDNS Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the PowerDNS Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["powerdns"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"apiUrl":{"type":"string","format":"uri","maxLength":512,"description":"The base URL of the PowerDNS web server, excluding the /api/v1 path."},"serverId":{"type":"string","maxLength":64,"description":"The PowerDNS API server ID. Leave unset unless you connect through a proxy fronting several servers; the Authoritative Server always reports 'localhost'."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether to reject PowerDNS TLS certificates that are not trusted. Defaults to true."},"sslCertificate":{"type":"string","maxLength":8192,"description":"A PEM-encoded CA certificate to trust when connecting to PowerDNS over HTTPS."}},"required":["apiUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PowerDNS (API Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updatePowerdnsAppConnection","tags":["App Connections"],"description":"Update the specified PowerDNS Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"apiUrl":{"type":"string","format":"uri","maxLength":512,"description":"The base URL of the PowerDNS web server, excluding the /api/v1 path."},"apiKey":{"type":"string","minLength":1,"maxLength":512,"description":"The value of the PowerDNS api-key setting."},"serverId":{"type":"string","maxLength":64,"description":"The PowerDNS API server ID. Leave unset unless you connect through a proxy fronting several servers; the Authoritative Server always reports 'localhost'."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether to reject PowerDNS TLS certificates that are not trusted. Defaults to true."},"sslCertificate":{"type":"string","maxLength":8192,"description":"A PEM-encoded CA certificate to trust when connecting to PowerDNS over HTTPS."}},"required":["apiUrl","apiKey"],"additionalProperties":false,"description":"The credentials used to connect with PowerDNS."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the PowerDNS Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the PowerDNS Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for PowerDNS Connections."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for PowerDNS Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for PowerDNS Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the PowerDNS Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["powerdns"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"apiUrl":{"type":"string","format":"uri","maxLength":512,"description":"The base URL of the PowerDNS web server, excluding the /api/v1 path."},"serverId":{"type":"string","maxLength":64,"description":"The PowerDNS API server ID. Leave unset unless you connect through a proxy fronting several servers; the Authoritative Server always reports 'localhost'."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether to reject PowerDNS TLS certificates that are not trusted. Defaults to true."},"sslCertificate":{"type":"string","maxLength":8192,"description":"A PEM-encoded CA certificate to trust when connecting to PowerDNS over HTTPS."}},"required":["apiUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PowerDNS (API Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deletePowerdnsAppConnection","tags":["App Connections"],"description":"Delete the specified PowerDNS Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the PowerDNS Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["powerdns"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"apiUrl":{"type":"string","format":"uri","maxLength":512,"description":"The base URL of the PowerDNS web server, excluding the /api/v1 path."},"serverId":{"type":"string","maxLength":64,"description":"The PowerDNS API server ID. Leave unset unless you connect through a proxy fronting several servers; the Authoritative Server always reports 'localhost'."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether to reject PowerDNS TLS certificates that are not trusted. Defaults to true."},"sslCertificate":{"type":"string","maxLength":8192,"description":"A PEM-encoded CA certificate to trust when connecting to PowerDNS over HTTPS."}},"required":["apiUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PowerDNS (API Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/powerdns/connection-name/{connectionName}":{"get":{"operationId":"getPowerdnsAppConnectionByName","tags":["App Connections"],"description":"Get the specified PowerDNS Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the PowerDNS Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the PowerDNS Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["powerdns"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"apiUrl":{"type":"string","format":"uri","maxLength":512,"description":"The base URL of the PowerDNS web server, excluding the /api/v1 path."},"serverId":{"type":"string","maxLength":64,"description":"The PowerDNS API server ID. Leave unset unless you connect through a proxy fronting several servers; the Authoritative Server always reports 'localhost'."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether to reject PowerDNS TLS certificates that are not trusted. Defaults to true."},"sslCertificate":{"type":"string","maxLength":8192,"description":"A PEM-encoded CA certificate to trust when connecting to PowerDNS over HTTPS."}},"required":["apiUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PowerDNS (API Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/powerdns/{connectionId}/rotate-credentials":{"post":{"operationId":"rotatePowerdnsAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified PowerDNS Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the PowerDNS Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["powerdns"]},"method":{"type":"string","enum":["api-key"]},"credentials":{"type":"object","properties":{"apiUrl":{"type":"string","format":"uri","maxLength":512,"description":"The base URL of the PowerDNS web server, excluding the /api/v1 path."},"serverId":{"type":"string","maxLength":64,"description":"The PowerDNS API server ID. Leave unset unless you connect through a proxy fronting several servers; the Authoritative Server always reports 'localhost'."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether to reject PowerDNS TLS certificates that are not trusted. Defaults to true."},"sslCertificate":{"type":"string","maxLength":8192,"description":"A PEM-encoded CA certificate to trust when connecting to PowerDNS over HTTPS."}},"required":["apiUrl"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"PowerDNS (API Key)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/mssql":{"get":{"operationId":"listMsSqlAppConnections","tags":["App Connections"],"description":"List the Microsoft SQL Server Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Microsoft SQL Server Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mssql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft SQL Server (Username and Password)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createMsSqlAppConnection","tags":["App Connections"],"description":"Create a Microsoft SQL Server Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["username-and-password"],"description":"The method used to authenticate with Microsoft SQL Server."},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"port":{"type":"number","description":"The port number of the database."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"password":{"type":"string","minLength":1,"description":"The password to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","port","database","username","password","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false,"description":"The credentials used to connect with Microsoft SQL Server."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Microsoft SQL Server Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Microsoft SQL Server Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Microsoft SQL Server Connection in."},"isPlatformManagedCredentials":{"type":"boolean","default":false,"description":"Whether or not the Microsoft SQL Server Connection credentials should be managed by Infisical. Once enabled this cannot be reversed."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Microsoft SQL Server Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Microsoft SQL Server Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mssql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft SQL Server (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/mssql/available":{"get":{"operationId":"listMsSqlAvailableAppConnections","tags":["App Connections"],"description":"List the Microsoft SQL Server Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Microsoft SQL Server Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["mssql"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/mssql/{connectionId}":{"get":{"operationId":"getMsSqlAppConnection","tags":["App Connections"],"description":"Get the specified Microsoft SQL Server Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Microsoft SQL Server Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mssql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft SQL Server (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateMsSqlAppConnection","tags":["App Connections"],"description":"Update the specified Microsoft SQL Server Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"port":{"type":"number","description":"The port number of the database."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"password":{"type":"string","minLength":1,"description":"The password to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","port","database","username","password","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false,"description":"The credentials used to connect with Microsoft SQL Server."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Microsoft SQL Server Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Microsoft SQL Server Connection."},"isPlatformManagedCredentials":{"type":"boolean","description":"Whether or not the Microsoft SQL Server Connection credentials should be managed by Infisical. Once enabled this cannot be reversed."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Microsoft SQL Server Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Microsoft SQL Server Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Microsoft SQL Server Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mssql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft SQL Server (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteMsSqlAppConnection","tags":["App Connections"],"description":"Delete the specified Microsoft SQL Server Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Microsoft SQL Server Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mssql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft SQL Server (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/mssql/connection-name/{connectionName}":{"get":{"operationId":"getMsSqlAppConnectionByName","tags":["App Connections"],"description":"Get the specified Microsoft SQL Server Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Microsoft SQL Server Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Microsoft SQL Server Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mssql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft SQL Server (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/mssql/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateMsSqlAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Microsoft SQL Server Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Microsoft SQL Server Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mssql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Microsoft SQL Server (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/mysql":{"get":{"operationId":"listMySqlAppConnections","tags":["App Connections"],"description":"List the MySQL Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list MySQL Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mysql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"MySQL (Username and Password)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createMySqlAppConnection","tags":["App Connections"],"description":"Create a MySQL Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["username-and-password"],"description":"The method used to authenticate with MySQL."},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"port":{"type":"number","description":"The port number of the database."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"password":{"type":"string","minLength":1,"description":"The password to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","port","database","username","password","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false,"description":"The credentials used to connect with MySQL."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the MySQL Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the MySQL Connection."},"projectId":{"type":"string","description":"The ID of the project to create the MySQL Connection in."},"isPlatformManagedCredentials":{"type":"boolean","default":false,"description":"Whether or not the MySQL Connection credentials should be managed by Infisical. Once enabled this cannot be reversed."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for MySQL Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for MySQL Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mysql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"MySQL (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/mysql/available":{"get":{"operationId":"listMySqlAvailableAppConnections","tags":["App Connections"],"description":"List the MySQL Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list MySQL Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["mysql"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/mysql/{connectionId}":{"get":{"operationId":"getMySqlAppConnection","tags":["App Connections"],"description":"Get the specified MySQL Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the MySQL Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mysql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"MySQL (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateMySqlAppConnection","tags":["App Connections"],"description":"Update the specified MySQL Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"port":{"type":"number","description":"The port number of the database."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"password":{"type":"string","minLength":1,"description":"The password to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","port","database","username","password","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false,"description":"The credentials used to connect with MySQL."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the MySQL Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the MySQL Connection."},"isPlatformManagedCredentials":{"type":"boolean","description":"Whether or not the MySQL Connection credentials should be managed by Infisical. Once enabled this cannot be reversed."},"gatewayId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway ID to use for this connection."},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true,"description":"The Gateway Pool ID to use for this connection."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for MySQL Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for MySQL Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the MySQL Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mysql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"MySQL (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteMySqlAppConnection","tags":["App Connections"],"description":"Delete the specified MySQL Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the MySQL Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mysql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"MySQL (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/mysql/connection-name/{connectionName}":{"get":{"operationId":"getMySqlAppConnectionByName","tags":["App Connections"],"description":"Get the specified MySQL Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the MySQL Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the MySQL Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mysql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"MySQL (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/mysql/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateMySqlAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified MySQL Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the MySQL Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["mysql"]},"method":{"type":"string","enum":["username-and-password"]},"credentials":{"type":"object","properties":{"host":{"type":"string","minLength":1,"description":"The hostname of the database server."},"database":{"type":"string","minLength":1,"description":"The name of the database to connect to."},"port":{"type":"number","description":"The port number of the database."},"username":{"type":"string","minLength":1,"description":"The username to connect to the database with."},"sslEnabled":{"type":"boolean","description":"Whether or not to use SSL when connecting to the database."},"sslRejectUnauthorized":{"type":"boolean","description":"Whether or not to reject unauthorized SSL certificates."},"sslCertificate":{"type":"string","description":"The SSL certificate to use for connection."}},"required":["host","database","port","username","sslEnabled","sslRejectUnauthorized"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"MySQL (Username and Password)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/camunda":{"get":{"operationId":"listCamundaAppConnections","tags":["App Connections"],"description":"List the Camunda Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Camunda Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["camunda"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1,"description":"The client ID used to authenticate with Camunda."}},"required":["clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Camunda (Client Credentials)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createCamundaAppConnection","tags":["App Connections"],"description":"Create a Camunda Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["client-credentials"],"description":"The method used to authenticate with Camunda."},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1,"description":"The client ID used to authenticate with Camunda."},"clientSecret":{"type":"string","minLength":1,"description":"The client secret used to authenticate with Camunda."}},"required":["clientId","clientSecret"],"additionalProperties":false,"description":"The credentials used to connect with Camunda."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Camunda Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Camunda Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Camunda Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Camunda Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Camunda Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Camunda Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Camunda Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Camunda Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["camunda"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1,"description":"The client ID used to authenticate with Camunda."}},"required":["clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Camunda (Client Credentials)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/camunda/available":{"get":{"operationId":"listCamundaAvailableAppConnections","tags":["App Connections"],"description":"List the Camunda Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Camunda Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["camunda"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/camunda/{connectionId}":{"get":{"operationId":"getCamundaAppConnection","tags":["App Connections"],"description":"Get the specified Camunda Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Camunda Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["camunda"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1,"description":"The client ID used to authenticate with Camunda."}},"required":["clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Camunda (Client Credentials)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateCamundaAppConnection","tags":["App Connections"],"description":"Update the specified Camunda Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1,"description":"The client ID used to authenticate with Camunda."},"clientSecret":{"type":"string","minLength":1,"description":"The client secret used to authenticate with Camunda."}},"required":["clientId","clientSecret"],"additionalProperties":false,"description":"The credentials used to connect with Camunda."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Camunda Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Camunda Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Camunda Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Camunda Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Camunda Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Camunda Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Camunda Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Camunda Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["camunda"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1,"description":"The client ID used to authenticate with Camunda."}},"required":["clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Camunda (Client Credentials)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteCamundaAppConnection","tags":["App Connections"],"description":"Delete the specified Camunda Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Camunda Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["camunda"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1,"description":"The client ID used to authenticate with Camunda."}},"required":["clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Camunda (Client Credentials)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/camunda/connection-name/{connectionName}":{"get":{"operationId":"getCamundaAppConnectionByName","tags":["App Connections"],"description":"Get the specified Camunda Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Camunda Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Camunda Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["camunda"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1,"description":"The client ID used to authenticate with Camunda."}},"required":["clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Camunda (Client Credentials)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/camunda/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateCamundaAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Camunda Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Camunda Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["camunda"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"clientId":{"type":"string","minLength":1,"description":"The client ID used to authenticate with Camunda."}},"required":["clientId"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Camunda (Client Credentials)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/windmill":{"get":{"operationId":"listWindmillAppConnections","tags":["App Connections"],"description":"List the Windmill Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Windmill Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["windmill"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","description":"The Windmill instance URL to connect with (defaults to https://app.windmill.dev)."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Windmill (Access Token)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createWindmillAppConnection","tags":["App Connections"],"description":"Create a Windmill Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["access-token"],"description":"The method used to authenticate with Windmill."},"credentials":{"type":"object","properties":{"accessToken":{"type":"string","minLength":1,"description":"The access token to use to connect with Windmill."},"instanceUrl":{"type":"string","format":"uri","description":"The Windmill instance URL to connect with (defaults to https://app.windmill.dev)."}},"required":["accessToken"],"additionalProperties":false,"description":"The credentials used to connect with Windmill."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Windmill Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Windmill Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Windmill Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Windmill Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Windmill Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Windmill Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Windmill Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Windmill Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["windmill"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","description":"The Windmill instance URL to connect with (defaults to https://app.windmill.dev)."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Windmill (Access Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/windmill/available":{"get":{"operationId":"listWindmillAvailableAppConnections","tags":["App Connections"],"description":"List the Windmill Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Windmill Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["windmill"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/windmill/{connectionId}":{"get":{"operationId":"getWindmillAppConnection","tags":["App Connections"],"description":"Get the specified Windmill Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Windmill Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["windmill"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","description":"The Windmill instance URL to connect with (defaults to https://app.windmill.dev)."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Windmill (Access Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateWindmillAppConnection","tags":["App Connections"],"description":"Update the specified Windmill Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"accessToken":{"type":"string","minLength":1,"description":"The access token to use to connect with Windmill."},"instanceUrl":{"type":"string","format":"uri","description":"The Windmill instance URL to connect with (defaults to https://app.windmill.dev)."}},"required":["accessToken"],"additionalProperties":false,"description":"The credentials used to connect with Windmill."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Windmill Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Windmill Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Windmill Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Windmill Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Windmill Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Windmill Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Windmill Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Windmill Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["windmill"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","description":"The Windmill instance URL to connect with (defaults to https://app.windmill.dev)."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Windmill (Access Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteWindmillAppConnection","tags":["App Connections"],"description":"Delete the specified Windmill Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Windmill Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["windmill"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","description":"The Windmill instance URL to connect with (defaults to https://app.windmill.dev)."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Windmill (Access Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/windmill/connection-name/{connectionName}":{"get":{"operationId":"getWindmillAppConnectionByName","tags":["App Connections"],"description":"Get the specified Windmill Connection by name.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The project ID of the Windmill Connection is associated with. Leave unspecified to get organization-level connections."},{"schema":{"type":"string","minLength":1},"in":"path","name":"connectionName","required":true,"description":"The name of the Windmill Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["windmill"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","description":"The Windmill instance URL to connect with (defaults to https://app.windmill.dev)."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Windmill (Access Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/windmill/{connectionId}/rotate-credentials":{"post":{"operationId":"rotateWindmillAppConnectionCredentials","tags":["App Connections"],"description":"Rotate the credentials for the specified Windmill Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Windmill Connection to rotate credentials for."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["windmill"]},"method":{"type":"string","enum":["access-token"]},"credentials":{"type":"object","properties":{"instanceUrl":{"type":"string","format":"uri","description":"The Windmill instance URL to connect with (defaults to https://app.windmill.dev)."}},"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Windmill (Access Token)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/auth0":{"get":{"operationId":"listAuth0AppConnections","tags":["App Connections"],"description":"List the Auth0 Connections for the current organization or project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Auth0 Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["auth0"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"description":"The domain of the Auth0 instance to connect to."},"clientId":{"type":"string","minLength":1,"description":"Your Auth0 application's Client ID."},"audience":{"type":"string","format":"uri","minLength":1,"description":"The unique identifier of the target API you want to access."}},"required":["domain","clientId","audience"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Auth0 (Client Credentials)"}]}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAuth0AppConnection","tags":["App Connections"],"description":"Create an Auth0 Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["client-credentials"],"description":"The method used to authenticate with Auth0."},"credentials":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"description":"The domain of the Auth0 instance to connect to."},"clientId":{"type":"string","minLength":1,"description":"Your Auth0 application's Client ID."},"clientSecret":{"type":"string","minLength":1,"description":"Your Auth0 application's Client Secret."},"audience":{"type":"string","format":"uri","minLength":1,"description":"The unique identifier of the target API you want to access."}},"required":["domain","clientId","clientSecret","audience"],"additionalProperties":false,"description":"The credentials used to connect with Auth0."}},"required":["method","credentials"],"additionalProperties":false}]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The name of the Auth0 Connection to create. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"An optional description for the Auth0 Connection."},"projectId":{"type":"string","description":"The ID of the project to create the Auth0 Connection in."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Auth0 Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Auth0 Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Auth0 Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Auth0 Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Auth0 Connections."}},"required":["name"]}]}}}},"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["auth0"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"description":"The domain of the Auth0 instance to connect to."},"clientId":{"type":"string","minLength":1,"description":"Your Auth0 application's Client ID."},"audience":{"type":"string","format":"uri","minLength":1,"description":"The unique identifier of the target API you want to access."}},"required":["domain","clientId","audience"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Auth0 (Client Credentials)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/auth0/available":{"get":{"operationId":"listAuth0AvailableAppConnections","tags":["App Connections"],"description":"List the Auth0 Connections the current user has permission to establish connections within this project.","parameters":[{"schema":{"type":"string"},"in":"query","name":"projectId","required":false,"description":"The ID of the project to list Auth0 Connections from."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnections":{"type":"array","items":{"type":"object","properties":{"app":{"type":"string","enum":["auth0"]},"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"projectId":{"type":"string","nullable":true},"orgId":{"type":"string"}},"required":["app","name","id","orgId"],"additionalProperties":false}}},"required":["appConnections"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}}},"/api/v1/app-connections/auth0/{connectionId}":{"get":{"operationId":"getAuth0AppConnection","tags":["App Connections"],"description":"Get the specified Auth0 Connection by ID.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Auth0 Connection to retrieve."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["auth0"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"description":"The domain of the Auth0 instance to connect to."},"clientId":{"type":"string","minLength":1,"description":"Your Auth0 application's Client ID."},"audience":{"type":"string","format":"uri","minLength":1,"description":"The unique identifier of the target API you want to access."}},"required":["domain","clientId","audience"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Auth0 (Client Credentials)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"patch":{"operationId":"updateAuth0AppConnection","tags":["App Connections"],"description":"Update the specified Auth0 Connection.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"credentials":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"description":"The domain of the Auth0 instance to connect to."},"clientId":{"type":"string","minLength":1,"description":"Your Auth0 application's Client ID."},"clientSecret":{"type":"string","minLength":1,"description":"Your Auth0 application's Client Secret."},"audience":{"type":"string","format":"uri","minLength":1,"description":"The unique identifier of the target API you want to access."}},"required":["domain","clientId","clientSecret","audience"],"additionalProperties":false,"description":"The credentials used to connect with Auth0."}}},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64,"description":"The updated name of the Auth0 Connection. Must be slug-friendly."},"description":{"type":"string","maxLength":256,"nullable":true,"description":"The updated description of the Auth0 Connection."},"isPlatformManagedCredentials":{"type":"boolean","enum":[false],"description":"Not supported for Auth0 Connections."},"gatewayId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Auth0 Connections."},"gatewayPoolId":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Auth0 Connections."},"isAutoRotationEnabled":{"type":"boolean","enum":[false],"description":"Not supported for Auth0 Connections."},"rotation":{"anyOf":[{"not":{}},{"enum":["null"],"nullable":true}],"description":"Not supported for Auth0 Connections."}}}]}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Auth0 Connection to be updated."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"],"additionalProperties":false,"description":"The credential rotation configuration, if configured."},"credentialsHash":{"type":"string"},"project":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"type":{"type":"string"},"slug":{"type":"string"}},"required":["name","id","type","slug"],"additionalProperties":false,"nullable":true},"app":{"type":"string","enum":["auth0"]},"method":{"type":"string","enum":["client-credentials"]},"credentials":{"type":"object","properties":{"domain":{"type":"string","minLength":1,"description":"The domain of the Auth0 instance to connect to."},"clientId":{"type":"string","minLength":1,"description":"Your Auth0 application's Client ID."},"audience":{"type":"string","format":"uri","minLength":1,"description":"The unique identifier of the target API you want to access."}},"required":["domain","clientId","audience"],"additionalProperties":false}},"required":["id","name","orgId","createdAt","updatedAt","app","method","credentials"],"additionalProperties":false,"title":"Auth0 (Client Credentials)"}]}},"required":["appConnection"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[400]},"message":{"type":"string"},"error":{"type":"string"},"details":{}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[401]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[403]},"message":{"type":"string"},"details":{},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[404]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[422]},"message":{},"error":{"type":"string"}},"required":["reqId","statusCode","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"reqId":{"type":"string"},"statusCode":{"type":"number","enum":[500]},"message":{"type":"string"},"error":{"type":"string"}},"required":["reqId","statusCode","message","error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAuth0AppConnection","tags":["App Connections"],"description":"Delete the specified Auth0 Connection.","parameters":[{"schema":{"type":"string","format":"uuid"},"in":"path","name":"connectionId","required":true,"description":"The ID of the Auth0 Connection to be deleted."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"appConnection":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"version":{"type":"number","default":1},"orgId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isPlatformManagedCredentials":{"type":"boolean","default":false,"nullable":true},"gatewayId":{"type":"string","format":"uuid","nullable":true},"projectId":{"type":"string","nullable":true},"isAutoRotationEnabled":{"type":"boolean","default":false},"gatewayPoolId":{"type":"string","format":"uuid","nullable":true},"rotation":{"type":"object","properties":{"lastRotationMessage":{"type":"string","nullable":true,"description":"The message from the last rotation attempt."},"rotationInterval":{"type":"number","description":"The interval in days between credential rotations."},"nextRotationAt":{"type":"string","format":"date-time","nullable":true,"description":"The next scheduled rotation time."},"rotationStatus":{"type":"string","enum":["success","failed"],"description":"The status of the last rotation attempt."},"rotateAtUtc":{"type":"object","properties":{"hours":{"type":"number","description":"The hour (0-23) at which to rotate."},"minutes":{"type":"number","description":"The minute (0-59) at which to rotate."}},"required":["hours","minutes"],"additionalProperties":false,"description":"The UTC time of day at which rotation should occur."}},"required":["rotationInterval","rotationStatus","rotateAtUtc"]