AttackForge
Search
K

InviteUserToProject

This method can be used for the following functionality: Invite a user to a project, by the project Id and username.

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": "[email protected]",
"accessLevel": "Edit"
}'

Response

Response contains a result object.
{
"result": {
"result": "User Invited"
}
}