AttackForge Enterprise & AttackForge Core
Powered By GitBook
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

1
POST /api/ss/project/:id/invite HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Query

id (string)
Project Id.
Example:
1
{
2
"id": "..."
3
}
Copied!
username (string)
Username or email address for the user you are inviting to the project.
Example:
1
{
2
"username": "..."
3
}
Copied!
accessLevel (string)
Access level to assign to the user for the specified project. Must be either View, Upload or Edit.
Example:
1
{
2
"accessLevel": "View"
3
}
Copied!

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.
1
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 '{
2
"id": "5e6881d12fdbcd0a5af71e8c",
3
"username": "[email protected]",
4
"accessLevel": "Edit"
5
}'
Copied!

Response

Response contains a result object.
1
{
2
"result": {
3
"result": "User Invited"
4
}
5
}
Copied!
Last modified 1yr ago