> **Can't find what you're looking for?** Use `search_docs` on the docs MCP server at `https://docs.prividium.com/api/mcp` to find what you need.
>
> **Have feedback?** Use `submit_feedback` on the same MCP server.

# template-permissions

## GET /template-permissions/

`GET /template-permissions/`

List template permissions with pagination

### Query parameters

- `limit` `integer`
- `offset` `integer`
- `templateId` `integer`
- `methodSelector` `string`
- `roleId` `string`

### Responses

#### `200`: Default Response

Body (`application/json`):

- `items` `object[]` _(required)_
  - `id` `integer` _(required)_
  - `templateId` `integer` _(required)_
  - `methodSelector` `string` _(required)_
  - `accessType` `string` _(required)_
  - `functionSignature` `string` _(required)_
  - `ruleType` `string` _(required)_
  - `isUmbrella` `boolean` _(required)_
  - `organizationOnly` `boolean`
  - `createdAt` `string <date-time>` _(required)_
  - `updatedAt` `string <date-time>` _(required)_
  - `roles` `object[]`
    - `id` `string` _(required)_
    - `roleName` `string`
  - `argumentRestrictions` `object[]`
    - `argumentIndex` `integer` _(required)_
- `pagination` `object` _(required)_
  - `currentPage` `number` _(required)_
  - `totalPages` `number` _(required)_
  - `totalItems` `number` _(required)_
  - `limit` `number` _(required)_
  - `offset` `number` _(required)_

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `403`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl '/api/template-permissions/?limit=10&offset=0&templateId=0&methodSelector=string&roleId=string'
```

```ts
fetch('/api/template-permissions/?limit=10&offset=0&templateId=0&methodSelector=string&roleId=string')
```

## POST /template-permissions/

`POST /template-permissions/`

Create a new template permission

### Request body (required) (`application/json`)

- `templateId` `integer` _(required)_
- `methodSelector` `string`
- `accessType` `string` _(required)_
- `functionSignature` `string` _(required)_
- `ruleType` `string` _(required)_
- `isUmbrella` `boolean`
- `organizationOnly` `boolean`
- `roles` `object[]`
  - `id` `string` _(required)_
  - `roleName` `string`
- `argumentRestrictions` `object[]`
  - `argumentIndex` `integer` _(required)_

### Responses

#### `201`: Default Response

Body (`application/json`):

- `id` `integer` _(required)_
- `templateId` `integer` _(required)_
- `methodSelector` `string` _(required)_
- `accessType` `string` _(required)_
- `functionSignature` `string` _(required)_
- `ruleType` `string` _(required)_
- `isUmbrella` `boolean` _(required)_
- `organizationOnly` `boolean`
- `createdAt` `string <date-time>` _(required)_
- `updatedAt` `string <date-time>` _(required)_
- `roles` `object[]`
  - `id` `string` _(required)_
  - `roleName` `string`
- `argumentRestrictions` `object[]`
  - `argumentIndex` `integer` _(required)_

#### `400`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/template-permissions/ \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "templateId": 0,
  "methodSelector": "string",
  "accessType": "read",
  "functionSignature": "string",
  "ruleType": "public",
  "isUmbrella": true,
  "organizationOnly": true,
  "roles": [
    {
      "id": "string",
      "roleName": "string"
    }
  ],
  "argumentRestrictions": [
    {
      "argumentIndex": 0
    }
  ]
}'
```

```ts
fetch('/api/template-permissions/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    templateId: 0,
    methodSelector: 'string',
    accessType: 'read',
    functionSignature: 'string',
    ruleType: 'public',
    isUmbrella: true,
    organizationOnly: true,
    roles: [
      {
        id: 'string',
        roleName: 'string'
      }
    ],
    argumentRestrictions: [
      {
        argumentIndex: 0
      }
    ]
  })
})
```

## GET /template-permissions/{id}

`GET /template-permissions/{id}`

Get a template permission by id

### Path parameters

- `id` `number` _(required)_

### Responses

#### `200`: Default Response

Body (`application/json`):

- `id` `integer` _(required)_
- `templateId` `integer` _(required)_
- `methodSelector` `string` _(required)_
- `accessType` `string` _(required)_
- `functionSignature` `string` _(required)_
- `ruleType` `string` _(required)_
- `isUmbrella` `boolean` _(required)_
- `organizationOnly` `boolean`
- `createdAt` `string <date-time>` _(required)_
- `updatedAt` `string <date-time>` _(required)_
- `roles` `object[]`
  - `id` `string` _(required)_
  - `roleName` `string`
- `argumentRestrictions` `object[]`
  - `argumentIndex` `integer` _(required)_

#### `404`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/template-permissions/0
```

```ts
fetch('/api/template-permissions/0')
```

## PUT /template-permissions/{id}

`PUT /template-permissions/{id}`

Replace a template permission (full update). The method and template pointed by the permission cannot be changed.

### Path parameters

- `id` `number` _(required)_

### Request body (required) (`application/json`)

- `id` `integer`
- `templateId` `integer` _(required)_
- `methodSelector` `string` _(required)_
- `accessType` `string` _(required)_
- `functionSignature` `string` _(required)_
- `ruleType` `string` _(required)_
- `isUmbrella` `boolean` _(required)_
- `organizationOnly` `boolean` _(required)_
- `roles` `object[]` _(required)_
  - `id` `string` _(required)_
  - `roleName` `string`
- `argumentRestrictions` `object[]` _(required)_
  - `argumentIndex` `integer` _(required)_

### Responses

#### `200`: Default Response

Body (`application/json`):

- `id` `integer` _(required)_
- `templateId` `integer` _(required)_
- `methodSelector` `string` _(required)_
- `accessType` `string` _(required)_
- `functionSignature` `string` _(required)_
- `ruleType` `string` _(required)_
- `isUmbrella` `boolean` _(required)_
- `organizationOnly` `boolean`
- `createdAt` `string <date-time>` _(required)_
- `updatedAt` `string <date-time>` _(required)_
- `roles` `object[]`
  - `id` `string` _(required)_
  - `roleName` `string`
- `argumentRestrictions` `object[]`
  - `argumentIndex` `integer` _(required)_

#### `400`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `404`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/template-permissions/0 \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 0,
  "templateId": 0,
  "methodSelector": "string",
  "accessType": "read",
  "functionSignature": "string",
  "ruleType": "public",
  "isUmbrella": true,
  "organizationOnly": true,
  "roles": [
    {
      "id": "string",
      "roleName": "string"
    }
  ],
  "argumentRestrictions": [
    {
      "argumentIndex": 0
    }
  ]
}'
```

```ts
fetch('/api/template-permissions/0', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    id: 0,
    templateId: 0,
    methodSelector: 'string',
    accessType: 'read',
    functionSignature: 'string',
    ruleType: 'public',
    isUmbrella: true,
    organizationOnly: true,
    roles: [
      {
        id: 'string',
        roleName: 'string'
      }
    ],
    argumentRestrictions: [
      {
        argumentIndex: 0
      }
    ]
  })
})
```

## DELETE /template-permissions/{id}

`DELETE /template-permissions/{id}`

Delete a template permission

### Path parameters

- `id` `number` _(required)_

### Responses

#### `204`: Default Response

#### `404`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/template-permissions/0 \
  --request DELETE
```

```ts
fetch('/api/template-permissions/0', {
  method: 'DELETE'
})
```