Admins /workspace/{workspace-id}/admins

The admin users of a workspace.

Reading

GET /workspace/{workspace-id}/admins HTTP/1.1
Host: localhost:3000

Permissions

  • The applied permissions to retrieve the parent workspace are required.

Fields

An array of User objects who are admin of the parent workspace, in addition to the following field :


Name Description Type

perms

The admin permission.

enum{READ, MANAGE}

Publishing

POST /workspace/{workspace-id}/admins HTTP/1.1
Host: localhost:3000

Permissions

  • The applied permissions to update the parent workspace are required.

Fields

Name Description Type

users

The users at which set admin permission.

object[]

user

The User ID.
Must be an User belonging to the current workspace or the workspace at which is attached the current person.

string

perms

The admin permission.

enum{READ, MANAGE}

Response

If successful :

{
    "success": true
}

Otherwise a relevant error message will be returned.

Updating

You can't update admin permissions. Delete the admin permission and after that, publish an new admin permission.

Deleting

DELETE /workspace/{workspace-id}/admins HTTP/1.1
Host: localhost:3000

Permissions

  • The applied permissions to update the parent workspace are required.

Fields

Name Description Type

admins

An array of User IDs who have admin permission.

string[]

Response

If successful :

{
    "success": true
}

Otherwise a relevant error message will be returned.