User Roles

All Roles

get

This endpoint is used to fetch all roles in the current organization

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Query parameters

items_per_pageintegerRequired

Items Per Page

pageintegerRequired

Page Number

reversebooleanOptional

Sorting Order

sortstringOptional

Sorting Key

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

role_idstringRequired

role_namestring · max: 100Required

is_customer_rolebooleanOptional

is_admin_rolebooleanOptional

is_manager_rolebooleanOptional

is_observer_rolebooleanOptional

is_user_rolebooleanOptional

is_partner_rolebooleanOptional

is_organization_admin_rolebooleanOptional

is_pre_sales_consultantbooleanOptional

is_system_rolebooleanOptional

get/api/users/role/

GET /api/users/role/?items_per_page=1&page=1 HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "role_id": "text",
    "role_name": "text",
    "is_customer_role": true,
    "is_admin_role": true,
    "is_manager_role": true,
    "is_observer_role": true,
    "is_user_role": true,
    "is_partner_role": true,
    "is_organization_admin_role": true,
    "is_pre_sales_consultant": true,
    "is_system_role": true
  }
]

get

Adaptation of DRF ModelViewSet

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters

idstringRequired

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

role_idstringRequired

role_namestring · max: 100Required

is_customer_rolebooleanOptional

is_admin_rolebooleanOptional

is_manager_rolebooleanOptional

is_observer_rolebooleanOptional

is_user_rolebooleanOptional

is_partner_rolebooleanOptional

is_organization_admin_rolebooleanOptional

is_pre_sales_consultantbooleanOptional

is_system_rolebooleanOptional

get/api/users/role/{id}/

GET /api/users/role/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "role_id": "text",
  "role_name": "text",
  "is_customer_role": true,
  "is_admin_role": true,
  "is_manager_role": true,
  "is_observer_role": true,
  "is_user_role": true,
  "is_partner_role": true,
  "is_organization_admin_role": true,
  "is_pre_sales_consultant": true,
  "is_system_role": true
}

Edits the role with the given id

put

This endpoint is used to edit a role for the current organization

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters

idstringRequired

Body

Other propertiesanyOptional

Responses

200

No response body

No content

put/api/users/role/{id}/

PUT /api/users/role/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "Org Admin",
  "permission": {}
}

200

No response body

No content

Deletes the role with the given id

delete

This endpoint is used to delete a role for the current organization

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters

idstringRequired

Responses

204

No response body

No content

delete/api/users/role/{id}/

DELETE /api/users/role/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No response body

No content

patch

Adaptation of DRF ModelViewSet

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters

idstringRequired

Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

role_idstringOptional

role_namestring · max: 100Optional

is_customer_rolebooleanOptional

is_admin_rolebooleanOptional

is_manager_rolebooleanOptional

is_observer_rolebooleanOptional

is_user_rolebooleanOptional

is_partner_rolebooleanOptional

is_organization_admin_rolebooleanOptional

is_pre_sales_consultantbooleanOptional

is_system_rolebooleanOptional

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

role_idstringRequired

role_namestring · max: 100Required

is_customer_rolebooleanOptional

is_admin_rolebooleanOptional

is_manager_rolebooleanOptional

is_observer_rolebooleanOptional

is_user_rolebooleanOptional

is_partner_rolebooleanOptional

is_organization_admin_rolebooleanOptional

is_pre_sales_consultantbooleanOptional

is_system_rolebooleanOptional

patch/api/users/role/{id}/

PATCH /api/users/role/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 259

{
  "role_id": "text",
  "role_name": "text",
  "is_customer_role": true,
  "is_admin_role": true,
  "is_manager_role": true,
  "is_observer_role": true,
  "is_user_role": true,
  "is_partner_role": true,
  "is_organization_admin_role": true,
  "is_pre_sales_consultant": true,
  "is_system_role": true
}

200Success

{
  "role_id": "text",
  "role_name": "text",
  "is_customer_role": true,
  "is_admin_role": true,
  "is_manager_role": true,
  "is_observer_role": true,
  "is_user_role": true,
  "is_partner_role": true,
  "is_organization_admin_role": true,
  "is_pre_sales_consultant": true,
  "is_system_role": true
}

get

Adaptation of DRF ModelViewSet

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

role_idstringRequired

role_namestring · max: 100Required

is_customer_rolebooleanOptional

is_admin_rolebooleanOptional

is_manager_rolebooleanOptional

is_observer_rolebooleanOptional

is_user_rolebooleanOptional

is_partner_rolebooleanOptional

is_organization_admin_rolebooleanOptional

is_pre_sales_consultantbooleanOptional

is_system_rolebooleanOptional

get/api/users/role/option/

GET /api/users/role/option/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "role_id": "text",
  "role_name": "text",
  "is_customer_role": true,
  "is_admin_role": true,
  "is_manager_role": true,
  "is_observer_role": true,
  "is_user_role": true,
  "is_partner_role": true,
  "is_organization_admin_role": true,
  "is_pre_sales_consultant": true,
  "is_system_role": true
}