openapi: 3.0.3 info: title: Infisical Admin PKI Applications API description: List of all available APIs that can be consumed version: 0.0.1 servers: - url: https://us.infisical.com description: Production server (US) - url: https://eu.infisical.com description: Production server (EU) - url: http://localhost:8080 description: Local server tags: - name: PKI Applications paths: /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 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 required: - id - challengeType - includeCaCertInResponse - allowCertBasedRenewal - dynamicChallengeExpiryMinutes - dynamicChallengeMaxPending - scepEndpointUrl - challengeEndpointUrl - raCertificatePem - raCertExpiresAt additionalProperties: false nullable: true estConfigured: type: boolean acmeConfigured: type: boolean scepConfigured: type: boolean required: - applicationId - profileId - api - est - acme - scep - 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 challengePassword: type: string includeCaCertInResponse: type: boolean default: true allowCertBasedRenewal: type: boolean default: true dynamicChallengeExpiryMinutes: type: integer minimum: 5 maximum: 1440 dynamicChallengeMaxPending: type: integer minimum: 1 maximum: 1000 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 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: List 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 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: Create an alert on an application. 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 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: Update an alert on an application. 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 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: Delete an 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 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 components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: An access token in Infisical