All APIs in a glance

مدیریت کاربران از پیش ساخته شده شما

دانلود برای اوبونتو(AMD64)

دانلود برای اوبونتو(ARM64)

دانلود برای MacOSX

دانلود برای ویندوز

مطالب پیش رو برای زبان فارسی تهیه نشده است.

Here you can see the entire public API's that are available in the fireback. This is not including the backoffice APIs

You may need to check other sections of this documentation to find out about back-office APIs.

POST http://localhost:4500/role

Create a new role in the workspace, or use to update the role name or capabilities.

Sample body:

{
  "name": "role4",
  "capabilities": []
}

GET http://localhost:4500/roles

Get list of all roles in the specific workspace.

GET http://localhost:4500/capabilities

Get list of capabilities that are available in the system. Capabilities might vary based on user current roles in the workspace.

POST http://localhost:4500/role/assign

Assign a role to specific user in the workspace

Sample body:

{
  "roleId": "e6e40b82",
  "userId": "fc36cc69"
}

DELETE http://localhost:4500/role/:id

Remove specific role in the workspace

GET http://localhost:4500/profile

Get user profile information, personal data to show in the profile page.

POST http://localhost:4500/auth/user/signin

Sample body:

{
  "email": "cypress_user_55_27082@test.com",
  "password": "123321"
}

DELETE http://localhost:4500/auth/revoke

Revoke, or sign out the current user, with putting token in the headers

POST http://localhost:4500/request-reset-mail-password

Request forget password for the email, and it will send an email with link to the reset password form

Sample body:

{
  "email": "cypress_user_49_92421@test.com"
}

POST http://localhost:4500/reset-mail-password/:id

Resets the password of an email, with 'password' in the body and the password request id in the url.

Sample body:

{
  "password": "123456"
}

POST http://localhost:4500/workspace/invite

Send invitation via email to a user, by setting email and roleId we expect the user to have

Sample body:

{
  "email": "cypress_user_1_88131@test.com",
  "roleId": "890505e0"
}

GET http://localhost:4500/invite/:id

Access the information of the invitation publicly, can be used to generate the form of accepting invite, or redirection, etc.

POST http://localhost:4500/workspace/acceptInvite

Accept the invitation, and join the organization

Sample body:

{
  "inviteUniqueId": "1643d6cb"
}

GET http://localhost:4500/workspaces

Get the list of all workspaces that user is joined to.

POST http://localhost:4500/workspace

User can create a workspace, by just setting the name of it in the body.

Sample body:

{
  "name": "workspace_10840350"
}

DELETE http://localhost:4500/workspace

Delete the workspace, if user has the permission to do so.

POST http://localhost:4500/preferences

User can update his preferences by sending a string:any dictionary object.

Sample body:

{
  "theme": "ubuntu",
  "timezone": "Tehran/Asia"
}

POST http://localhost:4500/user/signin/email

Sample body:

{
  "email": "cypress_user_35_73829@test.com",
  "password": "123321"
}

POST http://localhost:4500/passport/signin/email

Sample body:

{
  "email": "cypress_user_48_96338@test.com",
  "password": "123321"
}

POST http://localhost:4500/passport/request-reset-mail-password

Request forget password for the email, and it will send an email with link to the reset password form

Sample body:

{
  "email": "cypress_user_48_96338@test.com"
}

POST http://localhost:4500/passport/reset-mail-password/:id

Resets the password of an email, with 'password' in the body and the password request id in the url.

Sample body:

{
  "password": "123456"
}

POST http://localhost:4500/workspace/role

Create a new role in the workspace, or use to update the role name or capabilities.

Sample body:

{
  "name": "Junior Developer",
  "capabilities": [],
  "parentRoleId": "0e74ca35"
}

GET http://localhost:4500/workspace/roles

Get list of all roles in the specific workspace.

GET http://localhost:4500/workspaces/invite/:id

Access the information of the invitation publicly, can be used to generate the form of accepting invite, or redirection, etc.

POST http://localhost:4500/workspace/role/assign

Assign a role to specific user in the workspace

Sample body:

{
  "roleId": "0e74ca35",
  "userId": "4fe83d4b"
}

DELETE http://localhost:4500/auth/revoke/43b808ff543f7c1943e9befc0dcb745fbce1785cf5142fdfaa33219e01a99a97

Revoke, or sign out the current user, with putting token in the headers

DELETE http://localhost:4500/auth/revoke/ab63408ae0a15d6ad3c65ec74c08ce0a2f65595fdbc67ee189688231138dbdf4

Revoke, or sign out the current user, with putting token in the headers

DELETE http://localhost:4500/auth/revoke/f98b61b45681105f40347c624db7d0426448382e145f573ccd6ca084c43263a2

Revoke, or sign out the current user, with putting token in the headers

DELETE http://localhost:4500/auth/revoke/5f8c5b74ff4ffeaad52ef34edcdfd67909b5bdb239d06e050f792e17659dca2b

Revoke, or sign out the current user, with putting token in the headers

DELETE http://localhost:4500/auth/revoke/54d9b23810669f8fb8f8e0dd99eb0cac498555479bd1c4e30fefaf5801c777c9

Revoke, or sign out the current user, with putting token in the headers

DELETE http://localhost:4500/auth/revoke/cb858fcadd706ebdd7e19224f569b4bddc4e19b9b84b59307959da5d4c51bbf5

Revoke, or sign out the current user, with putting token in the headers

DELETE http://localhost:4500/auth/revoke/2915fa846feabb1788794b06ffb35ca676b7f3b1529bcb9fa891ab82421ab07e

Revoke, or sign out the current user, with putting token in the headers

DELETE http://localhost:4500/auth/revoke/647970f227bc6acb448d6b50d130a8ef4bf4f01824e6f034e60678b2a20085f0

Revoke, or sign out the current user, with putting token in the headers

DELETE http://localhost:4500/auth/revoke/db8bcd284b563fcb3822264eedbdfdb089c2922c37d1d02b42de496585c3bb58

Revoke, or sign out the current user, with putting token in the headers

DELETE http://localhost:4500/auth/revoke/f38531bc0852779ea0b307f03b58f7e2eaab233c2ac479b799162ad15c8d9557

Revoke, or sign out the current user, with putting token in the headers

DELETE http://localhost:4500/auth/revoke/e90ccfd2f159760cd0b90cb66b3821e3896a978c807d3bd9aa2b4e7b9f0c5b2c

Revoke, or sign out the current user, with putting token in the headers

DELETE http://localhost:4500/auth/revoke/0a5d6058fd040b3fc79dd8b74133b9a8c4e50b702755d5ce83fc35ba2b5436e5

Revoke, or sign out the current user, with putting token in the headers

DELETE http://localhost:4500/auth/revoke/3270509bf01ad5944a897e343d6549f2cf2171ac857a031c9d493e9f626e691c

Revoke, or sign out the current user, with putting token in the headers

Ali Torabi

Software Engineer

My name is Ali Torabi, I am a software engineer who is highly interested in JavaScript, Golang and C++. I serve clients, build projects and create content and videos. Started programming in primary school, still at age of 30 it's main activity I do.