Skip to main content
PATCH
/
api
/
v1
/
project-templates
/
{templateId}
cURL
curl --request PATCH \
  --url https://us.infisical.com/api/v1/project-templates/{templateId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "roles": [
    {
      "name": "<string>",
      "slug": "<string>",
      "permissions": [
        {
          "subject": "secrets",
          "action": "read",
          "inverted": true,
          "conditions": {
            "environment": "<string>",
            "secretPath": "<string>",
            "secretName": "<string>",
            "secretTags": {
              "$in": [
                "<string>"
              ]
            },
            "eventType": "<string>"
          }
        }
      ]
    }
  ],
  "environments": [
    {
      "name": "<string>",
      "slug": "<string>",
      "position": 2
    }
  ],
  "users": [
    {
      "username": "<string>",
      "roles": [
        "<string>"
      ]
    }
  ],
  "groups": [
    {
      "groupSlug": "<string>",
      "roles": [
        "<string>"
      ]
    }
  ],
  "identities": [
    {
      "identityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "roles": [
        "<string>"
      ]
    }
  ],
  "projectManagedIdentities": [
    {
      "name": "<string>",
      "roles": [
        "<string>"
      ]
    }
  ]
}
'
{
  "projectTemplate": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "roles": [
      {
        "name": "<string>",
        "slug": "<string>",
        "permissions": [
          {
            "action": "<string>",
            "subject": "<string>",
            "conditions": "<unknown>",
            "inverted": true
          }
        ]
      }
    ],
    "environments": [
      {
        "name": "<string>",
        "slug": "<string>",
        "position": 2
      }
    ],
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "projectManagedIdentities": [
      {
        "name": "<string>",
        "roles": [
          "<string>"
        ]
      }
    ],
    "users": [
      {
        "username": "<string>",
        "roles": [
          "<string>"
        ]
      }
    ],
    "groups": [
      {
        "groupSlug": "<string>",
        "roles": [
          "<string>"
        ]
      }
    ],
    "identities": [
      {
        "identityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "roles": [
          "<string>"
        ]
      }
    ],
    "description": "<string>",
    "type": "secret-manager"
  }
}
You can read more about the role’s permissions field in the permissions documentation.

Path Parameters

​
templateId
string<uuid>
required

The ID of the project template to be updated.

Body

application/json
​
name
string

The updated name of the project template. Must be slug-friendly.

Required string length: 1 - 64
​
description
string

The updated description of the project template.

Maximum string length: 256
​
roles
object[]

The updated roles to be created when the template is applied to a project.

​
environments
object[] | null

The updated environments to be created when the template is applied to a project.

​
users
object[] | null

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
object[] | null

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
object[] | null

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
object[] | null

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.

Response

Default Response

​
projectTemplate
object
required