XP-Dev.com Documentation

Permissions API

This user guide only applies if your account and project is on our new platform, i.e. if your project's URL begins with https://<your-account>.xp-dev.com rather than https://xp-dev.com. If your account is on our old platform, you should be using this user guide instead.

Each Permission Object has the following attributes:

Attribute Description
id Unique permission ID
user User Object
permission Permission type, one of Read, Write, ProjectTrackingRead, ProjectTrackingWrite or Admin
project Project object that this permission applies to

Each User Object has the following attributes:

Attribute Description
id Unique user ID
username User's username

List all Project Permissions

GET request to https://<your-account>.xp-dev.com/api/v1/projectpermissions/project/<project-id>:

curl https://<your-account>.xp-dev.com/api/v1/projectpermissions/project/122

Responses will be a list of Permission Objects:

[
        {
            "id":13,
            "permission":"Write",
            "user": {
              "id": 4,
              "username": "simpleuser"
            },
            "project": {
                "id": 1
            }
        },
        {
            "id":41,
            "permission":"Admin",
            "user": {
              "id": 4,
              "username": "reader"
            },
            "project": {
                "id": 1
            }
        },
        {
            "id":64,
            "permission":"Write",
            "user": {
              "id": 4,
              "username": "otheruser"
            },
            "project": {
                "id": 1
            }
        },
        {
            "id":65,
            "permission":"Read",
            "user": {
              "id": 4,
              "username": "someotherreader"
            },
            "project": {
                "id": 1
            }
        }
]

List a Single Permission

GET request to https://<your-account>.xp-dev.com/api/v1/projectpermissions/<permission-id>:

curl https://<your-account>.xp-dev.com/api/v1/projectpermissions/65

Responses will be a Permission Object

Create a New Permission

POST request to https://<your-account>.xp-dev.com/api/v1/projectpermissions with the following attributes:

Mandatory:

  • permission, either Read, Write, ProjectTrackingRead, ProjectTrackingWrite or Admin
  • user
  • project

Example request:

curl -X POST -d '{"permission":"Read","user":{"username":"otheruser"},"project":{"id":56}}' -H 'Content-Type: application/json' https://<your-account>.xp-dev.com/api/v1/projectpermissions

Delete a Permission

DELETE request to https://<your-account>.xp-dev.com/api/v1/projectpermissions/<permission-id>:

curl -X DELETE https://<your-account>.xp-dev.com/api/v1/projectpermissions/65

Feel free to contact us if you need any assistance.