openapi: 3.0.3 info: title: Infisical Admin Project Templates 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: Project Templates paths: /api/v1/project-templates: get: tags: - Project Templates description: List project templates for the current organization. parameters: - schema: type: string enum: - secret-manager - cert-manager - kms - ssh - secret-scanning - pam - ai in: query name: type required: false description: The type of project template to list. responses: '200': description: Default Response content: application/json: schema: type: object properties: projectTemplates: type: array items: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true roles: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 permissions: type: array items: type: object properties: subject: anyOf: - type: string minLength: 1 - type: array items: type: string action: anyOf: - type: string minLength: 1 - type: array items: type: string conditions: {} inverted: type: boolean required: - action additionalProperties: false required: - name - slug - permissions additionalProperties: false environments: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 position: type: number minimum: 1 required: - name - slug - position additionalProperties: false nullable: true orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time type: type: string default: secret-manager projectManagedIdentities: type: array items: type: object properties: name: type: string minLength: 1 roles: type: array items: type: string required: - name - roles additionalProperties: false nullable: true users: type: array items: type: object properties: username: type: string minLength: 1 roles: type: array items: type: string required: - username - roles additionalProperties: false nullable: true groups: type: array items: type: object properties: groupSlug: type: string roles: type: array items: type: string required: - groupSlug - roles additionalProperties: false nullable: true identities: type: array items: type: object properties: identityId: type: string format: uuid identityName: type: string roles: type: array items: type: string required: - identityId - identityName - roles additionalProperties: false nullable: true required: - id - name - roles - environments - orgId - createdAt - updatedAt - projectManagedIdentities - users - groups - identities additionalProperties: false required: - projectTemplates additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false post: tags: - Project Templates description: Create a project template. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The name of the project template to be created. Must be slug-friendly. description: type: string maxLength: 256 description: An optional description of the project template. roles: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 permissions: type: array items: anyOf: - type: object properties: subject: type: string enum: - secrets description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - describeSecret - readValue - create - edit - delete - type: array items: type: string enum: - read - describeSecret - readValue - create - edit - delete minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretTags: type: object properties: $in: type: array items: type: string minLength: 1 $all: type: array items: type: string minLength: 1 additionalProperties: false eventType: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-folders description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-imports description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - dynamic-secrets description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read-root-credential - create-root-credential - edit-root-credential - delete-root-credential - lease - type: array items: type: string enum: - read-root-credential - create-root-credential - edit-root-credential - delete-root-credential - lease minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false metadata: type: object properties: $elemMatch: type: object properties: key: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false value: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false required: - $elemMatch additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - identity description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - grant-privileges - assign-role - assign-additional-privileges - assume-privileges - revoke-auth - create-token - get-token - delete-token - type: array items: type: string enum: - read - create - edit - delete - grant-privileges - assign-role - assign-additional-privileges - assume-privileges - revoke-auth - create-token - get-token - delete-token minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: identityId: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false assignableRole: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false assignableSubject: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false assignableAction: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - ssh-hosts description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - issue-host-cert - type: array items: type: string enum: - read - create - edit - delete - issue-host-cert minItems: 1 description: Describe what action an entity can take. inverted: type: boolean description: Whether rule allows or forbids. conditions: type: object properties: hostname: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $glob: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pki-subscribers description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - issue-cert - list-certs - type: array items: type: string enum: - read - create - edit - delete - issue-cert - list-certs minItems: 1 description: Describe what action an entity can take. inverted: type: boolean description: Whether rule allows or forbids. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $glob: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - certificate-templates description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - issue-cert - list-certs - type: array items: type: string enum: - read - create - edit - delete - issue-cert - list-certs minItems: 1 description: Describe what action an entity can take. inverted: type: boolean description: Whether rule allows or forbids. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $glob: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-rotation description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - read-generated-credentials - create - edit - delete - rotate-secrets - type: array items: type: string enum: - read - read-generated-credentials - create - edit - delete - rotate-secrets minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false connectionId: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-syncs description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - sync-secrets - import-secrets - remove-secrets - type: array items: type: string enum: - read - create - edit - delete - sync-secrets - import-secrets - remove-secrets minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false connectionId: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pki-syncs description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - sync-certificates - import-certificates - remove-certificates - type: array items: type: string enum: - read - create - edit - delete - sync-certificates - import-certificates - remove-certificates minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false subscriberName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-event-subscriptions description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - subscribe-to-creation-events - subscribe-to-update-events - subscribe-to-deletion-events - subscribe-to-import-mutation-events - type: array items: type: string enum: - subscribe-to-creation-events - subscribe-to-update-events - subscribe-to-deletion-events - subscribe-to-import-mutation-events minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false connectionId: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - certificate-profiles description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - issue-cert - reveal-acme-eab-secret - rotate-acme-eab-secret - manage-application-attachments - type: array items: type: string enum: - read - create - edit - delete - issue-cert - reveal-acme-eab-secret - rotate-acme-eab-secret - manage-application-attachments minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: slug: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - certificate-policies description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $glob: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - certificate-authorities description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - issue-ca-certificate - sign-intermediate - type: array items: type: string enum: - read - create - edit - delete - issue-ca-certificate - sign-intermediate minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - certificates description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - read-private-key - import - type: array items: type: string enum: - read - create - edit - delete - read-private-key - import minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: commonName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false altNames: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false serialNumber: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false friendlyName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false status: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false metadata: type: object properties: $elemMatch: type: object properties: key: type: object properties: $eq: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false value: type: object properties: $eq: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false required: - $elemMatch additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-approval description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-rollback description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - type: array items: type: string enum: - read - create minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - member description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - grant-privileges - assign-role - assign-additional-privileges - assume-privileges - type: array items: type: string enum: - read - create - edit - delete - grant-privileges - assign-role - assign-additional-privileges - assume-privileges minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: userEmail: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false assignableRole: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false assignableSubject: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false assignableAction: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - groups description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - grant-privileges - assign-role - type: array items: type: string enum: - read - create - edit - delete - grant-privileges - assign-role minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: groupName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false assignableRole: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - role description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - integrations description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - webhooks description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - service-tokens description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - settings description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - environments description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - tags description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - audit-logs description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - type: array items: type: string enum: - read minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - insights description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - type: array items: type: string enum: - read minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - ip-allowlist description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - ssh-certificate-authorities description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - ssh-certificates description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - ssh-certificate-templates description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - ssh-host-groups description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pki-alerts description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pki-collections description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - certificate-inventory-views description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pki-discovery description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - run-scan - type: array items: type: string enum: - read - create - edit - delete - run-scan minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pki-certificate-installations description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - edit - delete - type: array items: type: string enum: - read - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - code-signers description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - sign - type: array items: type: string enum: - read - create - edit - delete - sign minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - workspace description: The entity this permission pertains to. action: anyOf: - type: string enum: - edit - delete - type: array items: type: string enum: - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - kms description: The entity this permission pertains to. action: anyOf: - type: string enum: - edit - type: array items: type: string enum: - edit minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - cmek description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - encrypt - decrypt - sign - verify - export-private-key - type: array items: type: string enum: - read - create - edit - delete - encrypt - decrypt - sign - verify - export-private-key minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - kmip description: The entity this permission pertains to. action: anyOf: - type: string enum: - create-clients - update-clients - delete-clients - read-clients - generate-client-certificates - type: array items: type: string enum: - create-clients - update-clients - delete-clients - read-clients - generate-client-certificates minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - commits description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - perform-rollback - type: array items: type: string enum: - read - perform-rollback minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-scanning-data-sources description: The entity this permission pertains to. action: anyOf: - type: string enum: - read-data-sources - create-data-sources - edit-data-sources - delete-data-sources - trigger-data-source-scans - read-data-source-scans - read-data-source-resources - type: array items: type: string enum: - read-data-sources - create-data-sources - edit-data-sources - delete-data-sources - trigger-data-source-scans - read-data-source-scans - read-data-source-resources minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-scanning-findings description: The entity this permission pertains to. action: anyOf: - type: string enum: - read-findings - update-findings - type: array items: type: string enum: - read-findings - update-findings minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-scanning-configs description: The entity this permission pertains to. action: anyOf: - type: string enum: - read-configs - update-configs - type: array items: type: string enum: - read-configs - update-configs minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - app-connections description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read-app-connections - create-app-connections - edit-app-connections - delete-app-connections - connect-app-connections - rotate-credentials - type: array items: type: string enum: - read-app-connections - create-app-connections - edit-app-connections - delete-app-connections - connect-app-connections - rotate-credentials minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: connectionId: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-folders description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-resources description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false resourceType: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false metadata: type: object properties: $elemMatch: type: object properties: key: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false value: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false required: - $elemMatch additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-domains description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false domainType: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false metadata: type: object properties: $elemMatch: type: object properties: key: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false value: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false required: - $elemMatch additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given domain. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-accounts description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - access - read - create - edit - delete - trigger-rotation - read-credentials - type: array items: type: string enum: - access - read - create - edit - delete - trigger-rotation - read-credentials minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: resourceName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false accountName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false resourceType: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false domainName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false domainType: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false metadata: type: object properties: $elemMatch: type: object properties: key: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false value: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false required: - $elemMatch additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-sessions description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - terminate - type: array items: type: string enum: - read - terminate minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-account-policies description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-discovery description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - run-scan - type: array items: type: string enum: - read - create - edit - delete - run-scan minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-insights description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - type: array items: type: string enum: - read minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - mcp-endpoints description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - connect - type: array items: type: string enum: - read - create - edit - delete - connect minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $glob: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - mcp-servers description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - mcp-activity-logs description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - honey-tokens description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - read-credentials - create - edit - reset - revoke - type: array items: type: string enum: - read - read-credentials - create - edit - reset - revoke minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - approval-requests description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - type: array items: type: string enum: - read - create minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - approval-request-grants description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - revoke - type: array items: type: string enum: - read - revoke minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-approval-request description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - type: array items: type: string enum: - read minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false required: - name - slug - permissions additionalProperties: false default: [] description: The roles to be created when the template is applied to a project. type: type: string enum: - secret-manager - cert-manager - kms - ssh - secret-scanning - pam - ai description: The type of project template to be created. environments: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 position: type: number minimum: 1 required: - name - slug - position additionalProperties: false nullable: true description: The environments to be created when the template is applied to a project. users: type: array items: type: object properties: username: type: string minLength: 1 roles: type: array items: type: string minLength: 1 minItems: 1 required: - username - roles additionalProperties: false default: [] description: The users to be automatically added to projects created from this template. Each user is identified by username and assigned one or more roles. groups: type: array items: type: object properties: groupSlug: type: string minLength: 1 roles: type: array items: type: string minLength: 1 minItems: 1 required: - groupSlug - roles additionalProperties: false default: [] description: The groups to be automatically added to projects created from this template. Each group is identified by slug and assigned one or more roles. identities: type: array items: type: object properties: identityId: type: string format: uuid roles: type: array items: type: string minLength: 1 minItems: 1 required: - identityId - roles additionalProperties: false default: [] description: The organization-owned identities to be automatically added to projects created from this template. Each identity is identified by ID and assigned one or more roles. projectManagedIdentities: type: array items: type: object properties: name: type: string minLength: 1 roles: type: array items: type: string minLength: 1 minItems: 1 required: - name - roles additionalProperties: false default: [] description: The project-owned identities to be automatically created for projects created from this template. Each identity is identified by name and assigned one or more roles. required: - name - type additionalProperties: false responses: '200': description: Default Response content: application/json: schema: type: object properties: projectTemplate: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true roles: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 permissions: type: array items: type: object properties: subject: anyOf: - type: string minLength: 1 - type: array items: type: string action: anyOf: - type: string minLength: 1 - type: array items: type: string conditions: {} inverted: type: boolean required: - action additionalProperties: false required: - name - slug - permissions additionalProperties: false environments: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 position: type: number minimum: 1 required: - name - slug - position additionalProperties: false nullable: true orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time type: type: string default: secret-manager projectManagedIdentities: type: array items: type: object properties: name: type: string minLength: 1 roles: type: array items: type: string required: - name - roles additionalProperties: false nullable: true users: type: array items: type: object properties: username: type: string minLength: 1 roles: type: array items: type: string required: - username - roles additionalProperties: false nullable: true groups: type: array items: type: object properties: groupSlug: type: string roles: type: array items: type: string required: - groupSlug - roles additionalProperties: false nullable: true identities: type: array items: type: object properties: identityId: type: string format: uuid identityName: type: string roles: type: array items: type: string required: - identityId - identityName - roles additionalProperties: false nullable: true required: - id - name - roles - environments - orgId - createdAt - updatedAt - projectManagedIdentities - users - groups - identities additionalProperties: false required: - projectTemplate additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false /api/v1/project-templates/{templateId}: get: tags: - Project Templates description: Get a project template by ID. parameters: - schema: type: string format: uuid in: path name: templateId required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: projectTemplate: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true roles: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 permissions: type: array items: type: object properties: subject: anyOf: - type: string minLength: 1 - type: array items: type: string action: anyOf: - type: string minLength: 1 - type: array items: type: string conditions: {} inverted: type: boolean required: - action additionalProperties: false required: - name - slug - permissions additionalProperties: false environments: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 position: type: number minimum: 1 required: - name - slug - position additionalProperties: false nullable: true orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time type: type: string default: secret-manager projectManagedIdentities: type: array items: type: object properties: name: type: string minLength: 1 roles: type: array items: type: string required: - name - roles additionalProperties: false nullable: true users: type: array items: type: object properties: username: type: string minLength: 1 roles: type: array items: type: string required: - username - roles additionalProperties: false nullable: true groups: type: array items: type: object properties: groupSlug: type: string roles: type: array items: type: string required: - groupSlug - roles additionalProperties: false nullable: true identities: type: array items: type: object properties: identityId: type: string format: uuid identityName: type: string roles: type: array items: type: string required: - identityId - identityName - roles additionalProperties: false nullable: true required: - id - name - roles - environments - orgId - createdAt - updatedAt - projectManagedIdentities - users - groups - identities additionalProperties: false required: - projectTemplate additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false patch: tags: - Project Templates description: Update a project template. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 64 description: The updated name of the project template. Must be slug-friendly. description: type: string maxLength: 256 description: The updated description of the project template. roles: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 permissions: type: array items: anyOf: - type: object properties: subject: type: string enum: - secrets description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - describeSecret - readValue - create - edit - delete - type: array items: type: string enum: - read - describeSecret - readValue - create - edit - delete minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretTags: type: object properties: $in: type: array items: type: string minLength: 1 $all: type: array items: type: string minLength: 1 additionalProperties: false eventType: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-folders description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-imports description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - dynamic-secrets description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read-root-credential - create-root-credential - edit-root-credential - delete-root-credential - lease - type: array items: type: string enum: - read-root-credential - create-root-credential - edit-root-credential - delete-root-credential - lease minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false metadata: type: object properties: $elemMatch: type: object properties: key: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false value: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false required: - $elemMatch additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - identity description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - grant-privileges - assign-role - assign-additional-privileges - assume-privileges - revoke-auth - create-token - get-token - delete-token - type: array items: type: string enum: - read - create - edit - delete - grant-privileges - assign-role - assign-additional-privileges - assume-privileges - revoke-auth - create-token - get-token - delete-token minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: identityId: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false assignableRole: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false assignableSubject: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false assignableAction: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - ssh-hosts description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - issue-host-cert - type: array items: type: string enum: - read - create - edit - delete - issue-host-cert minItems: 1 description: Describe what action an entity can take. inverted: type: boolean description: Whether rule allows or forbids. conditions: type: object properties: hostname: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $glob: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pki-subscribers description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - issue-cert - list-certs - type: array items: type: string enum: - read - create - edit - delete - issue-cert - list-certs minItems: 1 description: Describe what action an entity can take. inverted: type: boolean description: Whether rule allows or forbids. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $glob: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - certificate-templates description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - issue-cert - list-certs - type: array items: type: string enum: - read - create - edit - delete - issue-cert - list-certs minItems: 1 description: Describe what action an entity can take. inverted: type: boolean description: Whether rule allows or forbids. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $glob: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-rotation description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - read-generated-credentials - create - edit - delete - rotate-secrets - type: array items: type: string enum: - read - read-generated-credentials - create - edit - delete - rotate-secrets minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false connectionId: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-syncs description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - sync-secrets - import-secrets - remove-secrets - type: array items: type: string enum: - read - create - edit - delete - sync-secrets - import-secrets - remove-secrets minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false connectionId: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pki-syncs description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - sync-certificates - import-certificates - remove-certificates - type: array items: type: string enum: - read - create - edit - delete - sync-certificates - import-certificates - remove-certificates minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false subscriberName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-event-subscriptions description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - subscribe-to-creation-events - subscribe-to-update-events - subscribe-to-deletion-events - subscribe-to-import-mutation-events - type: array items: type: string enum: - subscribe-to-creation-events - subscribe-to-update-events - subscribe-to-deletion-events - subscribe-to-import-mutation-events minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false connectionId: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - certificate-profiles description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - issue-cert - reveal-acme-eab-secret - rotate-acme-eab-secret - manage-application-attachments - type: array items: type: string enum: - read - create - edit - delete - issue-cert - reveal-acme-eab-secret - rotate-acme-eab-secret - manage-application-attachments minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: slug: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - certificate-policies description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $glob: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - certificate-authorities description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - issue-ca-certificate - sign-intermediate - type: array items: type: string enum: - read - create - edit - delete - issue-ca-certificate - sign-intermediate minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - certificates description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - read-private-key - import - type: array items: type: string enum: - read - create - edit - delete - read-private-key - import minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: commonName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false altNames: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false serialNumber: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false friendlyName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false status: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false metadata: type: object properties: $elemMatch: type: object properties: key: type: object properties: $eq: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false value: type: object properties: $eq: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false required: - $elemMatch additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-approval description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-rollback description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - type: array items: type: string enum: - read - create minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - member description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - grant-privileges - assign-role - assign-additional-privileges - assume-privileges - type: array items: type: string enum: - read - create - edit - delete - grant-privileges - assign-role - assign-additional-privileges - assume-privileges minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: userEmail: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false assignableRole: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false assignableSubject: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false assignableAction: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - groups description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - grant-privileges - assign-role - type: array items: type: string enum: - read - create - edit - delete - grant-privileges - assign-role minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: groupName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false assignableRole: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - role description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - integrations description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - webhooks description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - service-tokens description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - settings description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - environments description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - tags description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - audit-logs description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - type: array items: type: string enum: - read minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - insights description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - type: array items: type: string enum: - read minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - ip-allowlist description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - ssh-certificate-authorities description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - ssh-certificates description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - ssh-certificate-templates description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - ssh-host-groups description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pki-alerts description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pki-collections description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - certificate-inventory-views description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pki-discovery description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - run-scan - type: array items: type: string enum: - read - create - edit - delete - run-scan minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pki-certificate-installations description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - edit - delete - type: array items: type: string enum: - read - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - code-signers description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - sign - type: array items: type: string enum: - read - create - edit - delete - sign minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - workspace description: The entity this permission pertains to. action: anyOf: - type: string enum: - edit - delete - type: array items: type: string enum: - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - kms description: The entity this permission pertains to. action: anyOf: - type: string enum: - edit - type: array items: type: string enum: - edit minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - cmek description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - encrypt - decrypt - sign - verify - export-private-key - type: array items: type: string enum: - read - create - edit - delete - encrypt - decrypt - sign - verify - export-private-key minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - kmip description: The entity this permission pertains to. action: anyOf: - type: string enum: - create-clients - update-clients - delete-clients - read-clients - generate-client-certificates - type: array items: type: string enum: - create-clients - update-clients - delete-clients - read-clients - generate-client-certificates minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - commits description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - perform-rollback - type: array items: type: string enum: - read - perform-rollback minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-scanning-data-sources description: The entity this permission pertains to. action: anyOf: - type: string enum: - read-data-sources - create-data-sources - edit-data-sources - delete-data-sources - trigger-data-source-scans - read-data-source-scans - read-data-source-resources - type: array items: type: string enum: - read-data-sources - create-data-sources - edit-data-sources - delete-data-sources - trigger-data-source-scans - read-data-source-scans - read-data-source-resources minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-scanning-findings description: The entity this permission pertains to. action: anyOf: - type: string enum: - read-findings - update-findings - type: array items: type: string enum: - read-findings - update-findings minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-scanning-configs description: The entity this permission pertains to. action: anyOf: - type: string enum: - read-configs - update-configs - type: array items: type: string enum: - read-configs - update-configs minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - app-connections description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read-app-connections - create-app-connections - edit-app-connections - delete-app-connections - connect-app-connections - rotate-credentials - type: array items: type: string enum: - read-app-connections - create-app-connections - edit-app-connections - delete-app-connections - connect-app-connections - rotate-credentials minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: connectionId: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-folders description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-resources description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false resourceType: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false metadata: type: object properties: $elemMatch: type: object properties: key: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false value: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false required: - $elemMatch additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-domains description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false domainType: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false metadata: type: object properties: $elemMatch: type: object properties: key: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false value: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false required: - $elemMatch additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given domain. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-accounts description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - access - read - create - edit - delete - trigger-rotation - read-credentials - type: array items: type: string enum: - access - read - create - edit - delete - trigger-rotation - read-credentials minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: resourceName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false accountName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false resourceType: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false domainName: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false domainType: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false metadata: type: object properties: $elemMatch: type: object properties: key: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false value: type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false required: - $elemMatch additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-sessions description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - terminate - type: array items: type: string enum: - read - terminate minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-account-policies description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-discovery description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - run-scan - type: array items: type: string enum: - read - create - edit - delete - run-scan minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - pam-insights description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - type: array items: type: string enum: - read minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - mcp-endpoints description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - create - edit - delete - connect - type: array items: type: string enum: - read - create - edit - delete - connect minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: name: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $glob: type: string minLength: 1 $in: type: array items: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - mcp-servers description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - mcp-activity-logs description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - edit - delete - type: array items: type: string enum: - read - create - edit - delete minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - honey-tokens description: The entity this permission pertains to. inverted: type: boolean description: Whether rule allows or forbids. action: anyOf: - type: string enum: - read - read-credentials - create - edit - reset - revoke - type: array items: type: string enum: - read - read-credentials - create - edit - reset - revoke minItems: 1 description: Describe what action an entity can take. conditions: type: object properties: environment: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false secretPath: anyOf: - type: string - type: object properties: $eq: type: string minLength: 1 $ne: type: string minLength: 1 $in: type: array items: type: string minLength: 1 $glob: type: string minLength: 1 additionalProperties: false additionalProperties: false description: When specified, only matching conditions will be allowed to access given resource. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - approval-requests description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - create - type: array items: type: string enum: - read - create minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - approval-request-grants description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - revoke - type: array items: type: string enum: - read - revoke minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false - type: object properties: subject: type: string enum: - secret-approval-request description: The entity this permission pertains to. action: anyOf: - type: string enum: - read - type: array items: type: string enum: - read minItems: 1 description: Describe what action an entity can take. required: - subject - action additionalProperties: false required: - name - slug - permissions additionalProperties: false description: The updated roles to be created when the template is applied to a project. environments: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 position: type: number minimum: 1 required: - name - slug - position additionalProperties: false nullable: true description: The updated environments to be created when the template is applied to a project. users: type: array items: type: object properties: username: type: string minLength: 1 roles: type: array items: type: string minLength: 1 minItems: 1 required: - username - roles additionalProperties: false nullable: true description: The updated users to be automatically added to projects created from this template. Each user is identified by username and assigned one or more roles. groups: type: array items: type: object properties: groupSlug: type: string minLength: 1 roles: type: array items: type: string minLength: 1 minItems: 1 required: - groupSlug - roles additionalProperties: false nullable: true description: The updated groups to be automatically added to projects created from this template. Each group is identified by slug and assigned one or more roles. identities: type: array items: type: object properties: identityId: type: string format: uuid roles: type: array items: type: string minLength: 1 minItems: 1 required: - identityId - roles additionalProperties: false nullable: true description: The updated organization-owned identities to be automatically added to projects created from this template. Each identity is identified by ID and assigned one or more roles. projectManagedIdentities: type: array items: type: object properties: name: type: string minLength: 1 roles: type: array items: type: string minLength: 1 minItems: 1 required: - name - roles additionalProperties: false nullable: true description: The updated project-owned identities to be automatically created for projects created from this template. Each identity is identified by name and assigned one or more roles. additionalProperties: false parameters: - schema: type: string format: uuid in: path name: templateId required: true description: The ID of the project template to be updated. responses: '200': description: Default Response content: application/json: schema: type: object properties: projectTemplate: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true roles: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 permissions: type: array items: type: object properties: subject: anyOf: - type: string minLength: 1 - type: array items: type: string action: anyOf: - type: string minLength: 1 - type: array items: type: string conditions: {} inverted: type: boolean required: - action additionalProperties: false required: - name - slug - permissions additionalProperties: false environments: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 position: type: number minimum: 1 required: - name - slug - position additionalProperties: false nullable: true orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time type: type: string default: secret-manager projectManagedIdentities: type: array items: type: object properties: name: type: string minLength: 1 roles: type: array items: type: string required: - name - roles additionalProperties: false nullable: true users: type: array items: type: object properties: username: type: string minLength: 1 roles: type: array items: type: string required: - username - roles additionalProperties: false nullable: true groups: type: array items: type: object properties: groupSlug: type: string roles: type: array items: type: string required: - groupSlug - roles additionalProperties: false nullable: true identities: type: array items: type: object properties: identityId: type: string format: uuid identityName: type: string roles: type: array items: type: string required: - identityId - identityName - roles additionalProperties: false nullable: true required: - id - name - roles - environments - orgId - createdAt - updatedAt - projectManagedIdentities - users - groups - identities additionalProperties: false required: - projectTemplate additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false delete: tags: - Project Templates description: Delete a project template. parameters: - schema: type: string format: uuid in: path name: templateId required: true description: The ID of the project template to be deleted. responses: '200': description: Default Response content: application/json: schema: type: object properties: projectTemplate: type: object properties: id: type: string format: uuid name: type: string description: type: string nullable: true roles: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 permissions: type: array items: type: object properties: subject: anyOf: - type: string minLength: 1 - type: array items: type: string action: anyOf: - type: string minLength: 1 - type: array items: type: string conditions: {} inverted: type: boolean required: - action additionalProperties: false required: - name - slug - permissions additionalProperties: false environments: type: array items: type: object properties: name: type: string minLength: 1 slug: type: string minLength: 1 maxLength: 64 position: type: number minimum: 1 required: - name - slug - position additionalProperties: false nullable: true orgId: type: string format: uuid createdAt: type: string format: date-time updatedAt: type: string format: date-time type: type: string default: secret-manager projectManagedIdentities: type: array items: type: object properties: name: type: string minLength: 1 roles: type: array items: type: string required: - name - roles additionalProperties: false nullable: true users: type: array items: type: object properties: username: type: string minLength: 1 roles: type: array items: type: string required: - username - roles additionalProperties: false nullable: true groups: type: array items: type: object properties: groupSlug: type: string roles: type: array items: type: string required: - groupSlug - roles additionalProperties: false nullable: true identities: type: array items: type: object properties: identityId: type: string format: uuid identityName: type: string roles: type: array items: type: string required: - identityId - identityName - roles additionalProperties: false nullable: true required: - id - name - roles - environments - orgId - createdAt - updatedAt - projectManagedIdentities - users - groups - identities additionalProperties: false required: - projectTemplate additionalProperties: false '400': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 400 message: type: string error: type: string details: {} required: - reqId - statusCode - message - error additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 401 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 403 message: type: string details: {} error: type: string required: - reqId - statusCode - message - error additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 404 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false '422': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 422 message: {} error: type: string required: - reqId - statusCode - error additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: reqId: type: string statusCode: type: number enum: - 500 message: type: string error: type: string required: - reqId - statusCode - message - error additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: An access token in Infisical