Users Permission Endpoints

This document provides detailed information about the permission assignment endpoints in the Amove API. Permissions attach a user or user group to a project or shared cloud drive and specify the level of access (Read or ReadWrite).

The 20 endpoints are organized in four CRUD + query groups:

User → Project — grant a single user access to a project
User → Shared Cloud Drive — grant a single user access to a shared cloud drive
User Group → Project — grant an entire group access to a project
User Group → Shared Cloud Drive — grant an entire group access to a shared cloud drive

All endpoints in this document require Authorization: Bearer <JWT>.

Permission Types

The permissionType field uses the ResourcePermissionType enum:

Value	Name	Description
1	Read	Read-only access
2	ReadWrite	Read and write access

Endpoints

User → Project

Add User Project Permission

Grants one or more users access to a project. The request body accepts an array so multiple assignments can be created in a single call.

URL: /api/v1/permission/users_project_permission
Method: POST
Auth Required: Yes

Request Body

[
  {
    "userId": "string (uuid)",
    "projectId": "string (uuid)",
    "permissionType": "integer (ResourcePermissionType)"
  }
]

Response

200 OK with an empty body.

Edit User Project Permission

Updates one or more existing user-to-project permission records (for example, to change Read to ReadWrite).

URL: /api/v1/permission/users_project_permission
Method: PUT
Auth Required: Yes

Request Body

[
  {
    "id": "string (uuid)",
    "userId": "string (uuid)",
    "projectId": "string (uuid)",
    "permissionType": "integer (ResourcePermissionType)"
  }
]

Response

200 OK with an empty body.

Delete User Project Permission

Removes a single user-to-project permission record by its id.

URL: /api/v1/permission/users_project_permission
Method: DELETE
Auth Required: Yes

Query Parameters

Parameter	Type	Description
id	string (uuid)	Permission record id.

Response

200 OK with an empty body.

Get Users Assigned To Project

Returns the users granted access to the given project, paginated.

URL: /api/v1/permission/get_users_assigned_to_project
Method: GET
Auth Required: Yes

Query Parameters

Parameter	Type	Default	Description
projectId	string (uuid)	—	Target project id
page	integer	1	Starting page
pagesize	integer	50	Page size
sortfield	string	"User.Username"	Field to sort by
descending	boolean	false	Sort direction
username	string	null	Case-insensitive substring match on username

Response

Returns a DTOCollection<UserProjectPermissionDTO> where each row has the shape:

{
  "user": { },
  "project": { },
  "permission": {
    "id": "string (uuid)",
    "userId": "string (uuid)",
    "projectId": "string (uuid)",
    "permissionType": "integer (ResourcePermissionType)"
  }
}

Get Projects Assigned To User

Returns the projects the given user has access to, paginated.

URL: /api/v1/permission/get_projects_assigned_to_user
Method: GET
Auth Required: Yes

Query Parameters

Parameter	Type	Default	Description
userId	string (uuid)	—	Target user id
page	integer	1	Starting page
pagesize	integer	50	Page size
sortfield	string	"Project.Name"	Field to sort by
descending	boolean	false	Sort direction
name	string	null	Case-insensitive substring match on project name

Response

Returns a DTOCollection<UserProjectPermissionDTO>.

User → Shared Cloud Drive

Note: the route spelling users_sharedclouddrive_permision has a single "s" in "permision" to match the existing server route.

Add User Shared Cloud Drive Permission

Grants one or more users access to a shared cloud drive.

URL: /api/v1/permission/users_sharedclouddrive_permision
Method: POST
Auth Required: Yes

Request Body

[
  {
    "userId": "string (uuid)",
    "sharedCloudDriveId": "string (uuid)",
    "permissionType": "integer (ResourcePermissionType)"
  }
]

Response

200 OK with an empty body.

Edit User Shared Cloud Drive Permission

Updates one or more existing user-to-shared-cloud-drive permission records.

URL: /api/v1/permission/users_sharedclouddrive_permision
Method: PUT
Auth Required: Yes

Request Body

[
  {
    "id": "string (uuid)",
    "userId": "string (uuid)",
    "sharedCloudDriveId": "string (uuid)",
    "permissionType": "integer (ResourcePermissionType)"
  }
]

Response

200 OK with an empty body.

Delete User Shared Cloud Drive Permission

Removes a single user-to-shared-cloud-drive permission record by its id.

URL: /api/v1/permission/users_sharedclouddrive_permision
Method: DELETE
Auth Required: Yes

Query Parameters

Parameter	Type	Description
id	string (uuid)	Permission record id.

Response

200 OK with an empty body.

Get Users Assigned To Shared Cloud Drive

Returns the users granted access to the given shared cloud drive, paginated.

URL: /api/v1/permission/get_users_assigned_to_sharedclouddrive
Method: GET
Auth Required: Yes

Query Parameters

Parameter	Type	Default	Description
sharedCloudDriveId	string (uuid)	—	Target shared cloud drive id
page	integer	1	Starting page
pagesize	integer	50	Page size
sortfield	string	"User.Username"	Field to sort by
descending	boolean	false	Sort direction
username	string	null	Case-insensitive substring match on username

Response

Returns a DTOCollection<UserSharedCloudDrivePermissionDTO> where each row has the shape:

{
  "user": { },
  "sharedClouDrive": { },
  "permission": {
    "id": "string (uuid)",
    "userId": "string (uuid)",
    "sharedCloudDriveId": "string (uuid)",
    "permissionType": "integer (ResourcePermissionType)"
  }
}

Get Shared Cloud Drive Assigned To User

Returns the shared cloud drives the given user has access to, paginated.

URL: /api/v1/permission/get_sharedclouddrive_assigned_to_user
Method: GET
Auth Required: Yes

Query Parameters

Parameter	Type	Default	Description
userId	string (uuid)	—	Target user id
page	integer	1	Starting page
pagesize	integer	50	Page size
sortfield	string	"SharedClouDrive.Name"	Field to sort by
descending	boolean	false	Sort direction
name	string	null	Case-insensitive substring match on shared cloud drive name

Response

Returns a DTOCollection<UserSharedCloudDrivePermissionDTO>.

User Group → Project

Add User Group Project Permission

Grants one or more user groups access to a project. Every member of a granted group inherits the permission.

URL: /api/v1/permission/usergroups_project_permission
Method: POST
Auth Required: Yes

Request Body

[
  {
    "userGroupId": "string (uuid)",
    "projectId": "string (uuid)",
    "permissionType": "integer (ResourcePermissionType)"
  }
]

Response

200 OK with an empty body.

Edit User Group Project Permission

Updates one or more existing user-group-to-project permission records.

URL: /api/v1/permission/usergroups_project_permission
Method: PUT
Auth Required: Yes

Request Body

[
  {
    "id": "string (uuid)",
    "userGroupId": "string (uuid)",
    "projectId": "string (uuid)",
    "permissionType": "integer (ResourcePermissionType)"
  }
]

Response

200 OK with an empty body.

Delete User Group Project Permission

Removes a single user-group-to-project permission record by its id.

URL: /api/v1/permission/usergroups_project_permission
Method: DELETE
Auth Required: Yes

Query Parameters

Parameter	Type	Description
id	string (uuid)	Permission record id.

Response

200 OK with an empty body.

Get User Groups Assigned To Project

Returns the user groups granted access to the given project, paginated.

URL: /api/v1/permission/get_usergroups_assigned_to_project
Method: GET
Auth Required: Yes

Query Parameters

Parameter	Type	Default	Description
projectId	string (uuid)	—	Target project id
page	integer	1	Starting page
pagesize	integer	50	Page size
sortfield	string	"UserGroup.Name"	Field to sort by
descending	boolean	false	Sort direction
name	string	null	Case-insensitive substring match on user group name

Response

Returns a DTOCollection<UserGroupProjectPermissionDTO> where each row has the shape:

{
  "userGroup": { },
  "project": { },
  "permission": {
    "id": "string (uuid)",
    "userGroupId": "string (uuid)",
    "projectId": "string (uuid)",
    "permissionType": "integer (ResourcePermissionType)"
  }
}

Get Projects Assigned To User Group

Returns the projects the given user group has access to, paginated.

URL: /api/v1/permission/get_projects_assigned_to_usergroup
Method: GET
Auth Required: Yes

Query Parameters

Parameter	Type	Default	Description
userGroupId	string (uuid)	—	Target user group id
page	integer	1	Starting page
pagesize	integer	50	Page size
sortfield	string	"Project.Name"	Field to sort by
descending	boolean	false	Sort direction
name	string	null	Case-insensitive substring match on project name

Response

Returns a DTOCollection<UserGroupProjectPermissionDTO>.

User Group → Shared Cloud Drive

Add User Group Shared Cloud Drive Permission

Grants one or more user groups access to a shared cloud drive.

URL: /api/v1/permission/usergroup_sharedclouddrive_permission
Method: POST
Auth Required: Yes

Request Body

[
  {
    "userGroupId": "string (uuid)",
    "sharedCloudDriveId": "string (uuid)",
    "permissionType": "integer (ResourcePermissionType)"
  }
]

Response

200 OK with an empty body.

Edit User Group Shared Cloud Drive Permission

Updates one or more existing user-group-to-shared-cloud-drive permission records.

URL: /api/v1/permission/usergroup_sharedclouddrive_permission
Method: PUT
Auth Required: Yes

Request Body

[
  {
    "id": "string (uuid)",
    "userGroupId": "string (uuid)",
    "sharedCloudDriveId": "string (uuid)",
    "permissionType": "integer (ResourcePermissionType)"
  }
]

Response

200 OK with an empty body.

Delete User Group Shared Cloud Drive Permission

Removes a single user-group-to-shared-cloud-drive permission record by its id.

URL: /api/v1/permission/usergroup_sharedclouddrive_permission
Method: DELETE
Auth Required: Yes

Query Parameters

Parameter	Type	Description
id	string (uuid)	Permission record id.

Response

200 OK with an empty body.

Get User Groups Assigned To Shared Cloud Drive

Returns the user groups granted access to the given shared cloud drive, paginated.

URL: /api/v1/permission/get_usergroups_assigned_to_sharedclouddrive
Method: GET
Auth Required: Yes

Query Parameters

Parameter	Type	Default	Description
sharedCloudDrive	string (uuid)	—	Target shared cloud drive id
page	integer	1	Starting page
pagesize	integer	50	Page size
sortfield	string	"UserGroup.Name"	Field to sort by
descending	boolean	false	Sort direction
name	string	null	Case-insensitive substring match on user group name

Response

Returns a DTOCollection<UserGroupSharedCloudDrivePermissionDTO> where each row has the shape:

{
  "userGroup": { },
  "sharedCloudDrive": { },
  "permission": {
    "id": "string (uuid)",
    "userGroupId": "string (uuid)",
    "sharedCloudDriveId": "string (uuid)",
    "permissionType": "integer (ResourcePermissionType)"
  }
}

Get Shared Cloud Drive Assigned To User Group

Returns the shared cloud drives the given user group has access to, paginated.

URL: /api/v1/permission/get_sharedclouddrive_assigned_to_usergroup
Method: GET
Auth Required: Yes

Query Parameters

Parameter	Type	Default	Description
userGroupId	string (uuid)	—	Target user group id
page	integer	1	Starting page
pagesize	integer	50	Page size
sortfield	string	"SharedCloudDrive.Name"	Field to sort by
descending	boolean	false	Sort direction
name	string	null	Case-insensitive substring match on shared cloud drive name

Response

Returns a DTOCollection<UserGroupSharedCloudDrivePermissionDTO>.

Sample Code

Grant a user read-write access to a project

Python

import requests

response = requests.post(
    "https://api.amove.io/api/v1/permission/users_project_permission",
    headers={"Authorization": "Bearer EXAMPLE_TOKEN"},
    json=[{
        "userId": "00000000-0000-0000-0000-000000000000",
        "projectId": "11111111-1111-1111-1111-111111111111",
        "permissionType": 2
    }]
)
print(response.status_code)

JavaScript

const res = await fetch("https://api.amove.io/api/v1/permission/users_project_permission", {
  method: "POST",
  headers: {
    "Authorization": "Bearer EXAMPLE_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify([{
    userId: "00000000-0000-0000-0000-000000000000",
    projectId: "11111111-1111-1111-1111-111111111111",
    permissionType: 2
  }])
});
console.log(res.status);

using System.Net.Http.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", "EXAMPLE_TOKEN");

object[] body = new[]
{
    new
    {
        userId = "00000000-0000-0000-0000-000000000000",
        projectId = "11111111-1111-1111-1111-111111111111",
        permissionType = 2
    }
};

HttpResponseMessage res = await client.PostAsJsonAsync(
    "https://api.amove.io/api/v1/permission/users_project_permission",
    body);
Console.WriteLine((int)res.StatusCode);

List the users assigned to a project

Python

import requests

response = requests.get(
    "https://api.amove.io/api/v1/permission/get_users_assigned_to_project",
    headers={"Authorization": "Bearer EXAMPLE_TOKEN"},
    params={
        "projectId": "11111111-1111-1111-1111-111111111111",
        "page": 1,
        "pagesize": 50
    }
)
print(response.json())

Grant a user group access to a shared cloud drive

JavaScript

const res = await fetch("https://api.amove.io/api/v1/permission/usergroup_sharedclouddrive_permission", {
  method: "POST",
  headers: {
    "Authorization": "Bearer EXAMPLE_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify([{
    userGroupId: "22222222-2222-2222-2222-222222222222",
    sharedCloudDriveId: "33333333-3333-3333-3333-333333333333",
    permissionType: 1
  }])
});
console.log(res.status);

For error handling, see Error Model.

Permission Types​

Endpoints​

User → Project​

User → Shared Cloud Drive​

User Group → Project​

User Group → Shared Cloud Drive​

User → Project​

Add User Project Permission​

Request Body​

Response​

Edit User Project Permission​

Request Body​

Response​

Delete User Project Permission​

Query Parameters​

Response​

Get Users Assigned To Project​

Query Parameters​

Response​

Get Projects Assigned To User​

Query Parameters​

Response​

User → Shared Cloud Drive​

Add User Shared Cloud Drive Permission​

Request Body​

Response​

Edit User Shared Cloud Drive Permission​

Request Body​

Response​

Delete User Shared Cloud Drive Permission​

Query Parameters​

Response​

Get Users Assigned To Shared Cloud Drive​

Query Parameters​

Response​

Get Shared Cloud Drive Assigned To User​

Query Parameters​

Response​

User Group → Project​

Add User Group Project Permission​

Request Body​

Response​

Edit User Group Project Permission​

Request Body​

Response​

Delete User Group Project Permission​

Query Parameters​

Response​

Get User Groups Assigned To Project​

Query Parameters​

Response​

Get Projects Assigned To User Group​

Query Parameters​

Response​

User Group → Shared Cloud Drive​

Add User Group Shared Cloud Drive Permission​

Request Body​

Response​

Edit User Group Shared Cloud Drive Permission​

Request Body​

Response​

Delete User Group Shared Cloud Drive Permission​

Query Parameters​

Response​

Get User Groups Assigned To Shared Cloud Drive​

Query Parameters​

Response​

Get Shared Cloud Drive Assigned To User Group​

Query Parameters​

Response​

Sample Code​

Grant a user read-write access to a project​

List the users assigned to a project​

Grant a user group access to a shared cloud drive​

Permission Types

Endpoints

User → Project

User → Shared Cloud Drive

User Group → Project

User Group → Shared Cloud Drive

User → Project

Add User Project Permission

Request Body

Response

Edit User Project Permission

Request Body

Response

Delete User Project Permission

Query Parameters

Response

Get Users Assigned To Project

Query Parameters

Response

Get Projects Assigned To User

Query Parameters

Response

User → Shared Cloud Drive

Add User Shared Cloud Drive Permission

Request Body

Response

Edit User Shared Cloud Drive Permission

Request Body

Response

Delete User Shared Cloud Drive Permission

Query Parameters

Response

Get Users Assigned To Shared Cloud Drive

Query Parameters

Response

Get Shared Cloud Drive Assigned To User

Query Parameters

Response

User Group → Project

Add User Group Project Permission

Request Body

Response

Edit User Group Project Permission

Request Body

Response

Delete User Group Project Permission

Query Parameters

Response

Get User Groups Assigned To Project

Query Parameters

Response

Get Projects Assigned To User Group

Query Parameters

Response

User Group → Shared Cloud Drive

Add User Group Shared Cloud Drive Permission

Request Body

Response

Edit User Group Shared Cloud Drive Permission

Request Body

Response

Delete User Group Shared Cloud Drive Permission

Query Parameters

Response

Get User Groups Assigned To Shared Cloud Drive

Query Parameters

Response

Get Shared Cloud Drive Assigned To User Group

Query Parameters

Response

Sample Code

Grant a user read-write access to a project

List the users assigned to a project

Grant a user group access to a shared cloud drive