> For the complete documentation index, see [llms.txt](https://support.attackforge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.attackforge.com/attackforge-enterprise/modules/self-service-restful-api/inviteusertoproject.md).

# InviteUserToProject

## Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

### Headers

```
POST /api/ss/project/:id/invite HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close
```

### Query

**id (string)**

Project Id.

Example:

```
{
   "id": "..."
}
```

**username (string)**

Username or email address for the user you are inviting to the project.

Example:

```
{
   "username": "..."
}
```

**accessLevel (string)**

Access level to assign to the user for the specified project. Must be either View, Upload or Edit.

Example:

```
{
   "accessLevel": "View"
}
```

**role (string) (optional)**

Collaboration role to assign to the user. Must be one of the following options: *Not Assigned, Client, Consultant, Pentester, Pentest Lead, Security Manager, Project Manager, Executive, Business Owner, Developer, Engineer, Architect, Red Team, Blue Team, SOC*

Example:

```
{
   "role": "Pentester"
}
```

## Example

The following example is a cURL request to add a user to a specified project.

### Request

Include API Token instead of stars in 'X-SSAPI-KEY: \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*' parameter.

```
curl -X POST 'https://demo.attackforge.com/api/ss/project/5e6881d12fdbcd0a5af71e8c/invite' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
  "id": "5e6881d12fdbcd0a5af71e8c",
  "username": "user@attackforge.com",
  "accessLevel": "Edit"
}'
```

### Response

Response contains a result object.

```
{
   "result": {
      "result": "User Invited"
   }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://support.attackforge.com/attackforge-enterprise/modules/self-service-restful-api/inviteusertoproject.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.