Infisical Project Roles API
The Project Roles API from Infisical — 6 operation(s) for project roles.
OpenAPI Specification
openapi: 3.0.3
info:
title: Infisical Admin Project Roles 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 Roles
paths:
/api/v1/projects/{projectId}/roles:
post:
tags:
- Project Roles
description: Create a project role
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
slug:
type: string
minLength: 1
maxLength: 64
description: The slug of the role.
name:
type: string
minLength: 1
description: The name of the role.
description:
type: string
nullable: true
description: The description for the role.
permissions:
type: array
items:
anyOf:
- type: object
properties:
subject:
type: string
enum:
- secrets
description: The entity this permission pertains to.
inverted:
type: boolean
description: Whether rule allows or forbids.
action:
anyOf:
- type: string
enum:
- read
- describeSecret
- readValue
- create
- edit
- delete
- type: array
items:
type: string
enum:
- read
- describeSecret
- readValue
- create
- edit
- delete
minItems: 1
description: Describe what action an entity can take.
conditions:
type: object
properties:
environment:
anyOf:
- type: string
- type: object
properties:
$eq:
type: string
minLength: 1
$ne:
type: string
minLength: 1
$in:
type: array
items:
type: string
minLength: 1
$glob:
type: string
minLength: 1
additionalProperties: false
secretPath:
anyOf:
- type: string
- type: object
properties:
$eq:
type: string
minLength: 1
$ne:
type: string
minLength: 1
$in:
type: array
items:
type: string
minLength: 1
$glob:
type: string
minLength: 1
additionalProperties: false
secretName:
anyOf:
- type: string
- type: object
properties:
$eq:
type: string
minLength: 1
$ne:
type: string
minLength: 1
$in:
type: array
items:
type: string
minLength: 1
$glob:
type: string
minLength: 1
additionalProperties: false
secretTags:
type: object
properties:
$in:
type: array
items:
type: string
minLength: 1
$all:
type: array
items:
type: string
minLength: 1
additionalProperties: false
eventType:
anyOf:
- type: string
- type: object
properties:
$eq:
type: string
minLength: 1
$ne:
type: string
minLength: 1
$in:
type: array
items:
type: string
minLength: 1
additionalProperties: false
additionalProperties: false
description: When specified, only matching conditions will be allowed to access given resource.
required:
- subject
- action
additionalProperties: false
- type: object
properties:
subject:
type: string
enum:
- secret-folders
description: The entity this permission pertains to.
inverted:
type: boolean
description: Whether rule allows or forbids.
action:
anyOf:
- type: string
enum:
- read
- create
- edit
- delete
- type: array
items:
type: string
enum:
- read
- create
- edit
- delete
minItems: 1
description: Describe what action an entity can take.
conditions:
type: object
properties:
environment:
anyOf:
- type: string
- type: object
properties:
$eq:
type: string
minLength: 1
$ne:
type: string
minLength: 1
$in:
type: array
items:
type: string
minLength: 1
additionalProperties: false
secretPath:
anyOf:
- type: string
- type: object
properties:
$eq:
type: string
minLength: 1
$ne:
type: string
minLength: 1
$in:
type: array
items:
type: string
minLength: 1
$glob:
type: string
minLength: 1
additionalProperties: false
additionalProperties: false
description: When specified, only matching conditions will be allowed to access given resource.
required:
- subject
- action
additionalProperties: false
- type: object
properties:
subject:
type: string
enum:
- secret-imports
description: The entity this permission pertains to.
inverted:
type: boolean
description: Whether rule allows or forbids.
action:
anyOf:
- type: string
enum:
- read
- create
- edit
- delete
- type: array
items:
type: string
enum:
- read
- create
- edit
- delete
minItems: 1
description: Describe what action an entity can take.
conditions:
type: object
properties:
environment:
anyOf:
- type: string
- type: object
properties:
$eq:
type: string
minLength: 1
$ne:
type: string
minLength: 1
$in:
type: array
items:
type: string
minLength: 1
$glob:
type: string
minLength: 1
additionalProperties: false
secretPath:
anyOf:
- type: string
- type: object
properties:
$eq:
type: string
minLength: 1
$ne:
type: string
minLength: 1
$in:
type: array
items:
type: string
minLength: 1
$glob:
type: string
minLength: 1
additionalProperties: false
additionalProperties: false
description: When specified, only matching conditions will be allowed to access given resource.
required:
- subject
- action
additionalProperties: false
- type: object
properties:
subject:
type: string
enum:
- dynamic-secrets
description: The entity this permission pertains to.
inverted:
type: boolean
description: Whether rule allows or forbids.
action:
anyOf:
- type: string
enum:
- read-root-credential
- create-root-credential
- edit-root-credential
- delete-root-credential
- lease
- type: array
items:
type: string
enum:
- read-root-credential
- create-root-credential
- edit-root-credential
- delete-root-credential
- lease
minItems: 1
description: Describe what action an entity can take.
conditions:
type: object
properties:
environment:
anyOf:
- type: string
- type: object
properties:
$eq:
type: string
minLength: 1
$ne:
type: string
minLength: 1
$in:
type: array
items:
type: string
minLength: 1
$glob:
type: string
minLength: 1
additionalProperties: false
secretPath:
anyOf:
- type: string
- type: object
properties:
$eq:
type: string
minLength: 1
$ne:
type: string
minLength: 1
$in:
type: array
items:
type: string
minLength: 1
$glob:
type: string
minLength: 1
additionalProperties: false
metadata:
type: object
properties:
$elemMatch:
type: object
properties:
key:
type: object
properties:
$eq:
type: string
minLength: 1
$ne:
type: string
minLength: 1
$in:
type: array
items:
type: string
minLength: 1
additionalProperties: false
value:
type: object
properties:
$eq:
type: string
minLength: 1
$ne:
type: string
minLength: 1
$in:
type: array
items:
type: string
minLength: 1
additionalProperties: false
additionalProperties: false
required:
- $elemMatch
additionalProperties: false
additionalProperties: false
description: When specified, only matching conditions will be allowed to access given resource.
required:
- subject
- action
additionalProperties: false
- type: object
properties:
subject:
type: string
enum:
- identity
description: The entity this permission pertains to.
inverted:
type: boolean
description: Whether rule allows or forbids.
action:
anyOf:
- type: string
enum:
- read
- create
- edit
- delete
- grant-privileges
- assign-role
- assign-additional-privileges
- assume-privileges
- revoke-auth
- 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:
- subj
# --- truncated at 32 KB (649 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infisical/refs/heads/main/openapi/infisical-project-roles-api-openapi.yml