---
title: "Access profiles · intentic sandbox API"
description: "Named sets of what a holder may reach, shared by people and services. Every route in the access profiles group of the intentic sandbox API."
url: "https://intentic.dev/api/accessProfiles/"
---

The workspace

# Access profiles

Named sets of what a holder may reach, shared by people and services

**On this page (3 sections)**

- [The access profiles](#accessProfiles-list)
- [Create or edit an access profile](#accessProfiles-save)
- [Delete an access profile](#accessProfiles-remove)

A profile names the areas, connections, secrets, AI accounts and tools its holders reach, so a team or a service is pointed at one answer rather than given its own copy. A maintainer reads them; both writes are the sandbox owner's, since editing one changes what everybody holding it may do and closes their open connections. A profile anyone or anything still holds cannot be deleted.

**GET`/access/profiles` The access profiles**

Every access profile this sandbox grants, its own and its organisation's: the areas, connections, secrets, AI accounts and tools each lets its holders reach.

### What you send

Nothing. Call it as it is.

### What comes back

| Field | Type |
| --- | --- |
| `profiles` Every profile this sandbox grants: its… | object[] |
| `id` The profile's id, the name a… | string |
| `label` What to call it on screen | string |
| `brief` What this access is for, in… | string |
| `areas` The areas its holders see and… | string[] |
| `agents` For a person: whether their conversations… | "off" | "chat" | "run" | "home" |
| `edit` For a person: where they change… | "all" | string[] |
| `lands` For a home-only person: whether their… | boolean |
| `credentials` The connected capabilities and stored secrets… | object |
| `capabilities` Connected capability ids their conversations may… | string[] |
| `secrets` Stored secret names (not a capability's… | string[] |
| `aiAccounts` The AI accounts its holders' turns… | string[] |
| `tools` The most its holders' turns' tools… | object |
| `files` The most it may do with… | "none" | "read" | "write" |
| `shell` False takes commands away, and with… | boolean |
| `code` False takes away writing and running… | boolean |
| `web` False takes away fetching a page… | boolean |
| `browser` False takes away the credential-free browser | boolean |
| `delegate` False takes away spawning subagents and… | boolean |
| `sandbox` False takes away changing the sandbox's… | boolean |
| `extensions` Which extensions' own agent tools and… | string[] |
| `assistants` For a guest who chats: which… | string[] |
| `roles` The role cards held to it:… | string[] |
| `origin` The sandbox's own, or the organisation's,… | "sandbox" | "org" |

Try it answered in this tab

curl

```bash
curl "$SANDBOX/access/profiles" \
 -H "x-intentic-control: $INTENTIC_TOKEN"
```

TypeScript

```typescript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.accessProfiles.list();
```

**POST`/access/profiles` Create or edit an access profile**

Writes the whole profile; sending an id that exists edits it. Everybody holding it changes with it: their roster rows are rewritten and their open connections closed, as a re-grade does. Answers with each person holding it and the tier they now hold.

### What you send

| Field | Type | Where |
| --- | --- | --- |
| `id` required The profile's id, the name a… | string | body |
| `label` What to call it on screen | string | body |
| `brief` What this access is for, in… | string | body |
| `areas` The areas its holders see and… | string[] | body |
| `agents` For a person: whether their conversations… | "off" | "chat" | "run" | "home" | body |
| `edit` For a person: where they change… | "all" | string[] | body |
| `lands` For a home-only person: whether their… | boolean | body |
| `credentials` The connected capabilities and stored secrets… | object | body |
| `capabilities` required Connected capability ids their conversations may… | string[] | body |
| `secrets` required Stored secret names (not a capability's… | string[] | body |
| `aiAccounts` The AI accounts its holders' turns… | string[] | body |
| `tools` The most its holders' turns' tools… | object | body |
| `files` The most it may do with… | "none" | "read" | "write" | body |
| `shell` False takes commands away, and with… | boolean | body |
| `code` False takes away writing and running… | boolean | body |
| `web` False takes away fetching a page… | boolean | body |
| `browser` False takes away the credential-free browser | boolean | body |
| `delegate` False takes away spawning subagents and… | boolean | body |
| `sandbox` False takes away changing the sandbox's… | boolean | body |
| `extensions` Which extensions' own agent tools and… | string[] | body |
| `assistants` For a guest who chats: which… | string[] | body |
| `roles` The role cards held to it:… | string[] | body |

### What comes back

| Field | Type |
| --- | --- |
| `ok` | true |
| `holders` The people whose rows were rewritten,… | object[] |
| `email` Who holds it, lowercased | string |
| `tier` The tier the profile makes for… | "guest" | "viewer" | "collaborator" | "writer" |

Try it answered in this tab

curl

```bash
curl -X POST "$SANDBOX/access/profiles" \
 -H "x-intentic-control: $INTENTIC_TOKEN" \
 -H "content-type: application/json" \
 -d '{"id":"a1b2c3d4","label":"Nightly changelog","brief":"…","areas":["…","…"],"agents":"off","edit":"all","lands":true,"credentials":{"capabilities":["…","…"],"secrets":["…","…"]},"aiAccounts":["…","…"],"tools":{"files":"none","shell":true,"code":true,"web":true,"browser":true,"delegate":true,"sandbox":true,"extensions":["ts","md"]},"assistants":["…","…"],"roles":["assistant","assistant"]}'
```

TypeScript

```typescript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.accessProfiles.save({
 "id": "a1b2c3d4",
 "label": "Nightly changelog",
 "brief": "…",
 "areas": [
 "…",
 "…"
 ],
 "agents": "off",
 "edit": "all",
 "lands": true,
 "credentials": {
 "capabilities": [
 "…",
 "…"
 ],
 "secrets": [
 "…",
 "…"
 ]
 },
 "aiAccounts": [
 "…",
 "…"
 ],
 "tools": {
 "files": "none",
 "shell": true,
 "code": true,
 "web": true,
 "browser": true,
 "delegate": true,
 "sandbox": true,
 "extensions": [
 "ts",
 "md"
 ]
 },
 "assistants": [
 "…",
 "…"
 ],
 "roles": [
 "assistant",
 "assistant"
 ]
});
```

**DELETE`/access/profiles/{id}` Delete an access profile**

Removes the profile. Refused while a person or a service still holds it; move them onto another profile, or onto answers of their own, first.

### What you send

| Field | Type | Where |
| --- | --- | --- |
| `id` required Which profile | string | address |

### What comes back

| Field | Type |
| --- | --- |
| `ok` Always true | true |

Try it answered in this tab

curl

```bash
curl -X DELETE "$SANDBOX/access/profiles/a1b2c3d4" \
 -H "x-intentic-control: $INTENTIC_TOKEN"
```

TypeScript

```typescript
import { sandbox } from "@intentic/sandbox-client";

const result = await sandbox.accessProfiles.remove({
 "id": "a1b2c3d4"
});
```

More in The workspace

[Previous ← Areas](https://intentic.dev/api/areas/)[Next Private conversations →](https://intentic.dev/api/seal/)
