Roles
The roles that give a user their permissions.
AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
keyword?stringWords to look for.
query?stringA filter, as a JSON object.
select?stringThe fields to return, as a JSON object of field names to 1 or 0.
skip?integerHow many to skip.
limit?integerHow many to return; 10 when absent.
10sort?stringThe order, as a JSON object of field names to 1 or -1.
One page, and how many match.
application/json- response
total?integerdata?array<>curl -X GET "https://platform.example.com/api/admin/role" \ -H "Authorization: Bearer $TOKEN"{ "total": 0, "data": [ { "_id": "string", "name": "string", "administration": null, "permission": null, "deletable": true, "props": null, "extendedProps": null, "createdAt": null, "createdBy": null, "updatedAt": null, "updatedBy": null } ]}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
application/json- body
keyword?stringWords to look for.
query?A filter, as a JSON object.
select?The fields to return, as a JSON object of field names to 1 or 0.
skip?integerHow many to skip.
limit?integerHow many to return; 10 when absent.
10sort?The order, as a JSON object of field names to 1 or -1.
One page, and how many match.
application/json- response
total?integerdata?array<>curl -X POST "https://platform.example.com/api/admin/role" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "keyword": "string", "query": {}, "select": {}}'{ "total": 0, "data": [ { "_id": "string", "name": "string", "administration": null, "permission": null, "deletable": true, "props": null, "extendedProps": null, "createdAt": null, "createdBy": null, "updatedAt": null, "updatedBy": null } ]}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
application/json- body
name*stringadministration?unknownpermission?unknowndeletable?booleantrueprops?extendedProps?The answer.
response?stringapplication/jsonThe id.
curl -X PUT "https://platform.example.com/api/admin/role" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "string"}'"string"AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the role.
select?stringThe fields to return, as a JSON object of field names to 1 or 0.
The record.
application/json- response
_id*stringname*stringadministration?unknownpermission?unknowndeletable?booleantrueprops?unknownextendedProps?unknowncreatedAt?unknowncreatedBy?unknownupdatedAt?unknownupdatedBy?unknowncurl -X GET "https://platform.example.com/api/admin/role/$ID" \ -H "Authorization: Bearer $TOKEN"{ "_id": "string", "name": "string", "administration": null, "permission": null, "deletable": true, "props": null, "extendedProps": null, "createdAt": null, "createdBy": null, "updatedAt": null, "updatedBy": null}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the role.
application/json- body
select?The fields to return, as a JSON object of field names to 1 or 0.
The record.
application/json- response
_id*stringname*stringadministration?unknownpermission?unknowndeletable?booleantrueprops?unknownextendedProps?unknowncreatedAt?unknowncreatedBy?unknownupdatedAt?unknownupdatedBy?unknowncurl -X POST "https://platform.example.com/api/admin/role/$ID" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "select": {}}'{ "_id": "string", "name": "string", "administration": null, "permission": null, "deletable": true, "props": null, "extendedProps": null, "createdAt": null, "createdBy": null, "updatedAt": null, "updatedBy": null}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the role.
The answer.
response?stringapplication/jsonThe id.
curl -X DELETE "https://platform.example.com/api/admin/role/$ID" \ -H "Authorization: Bearer $TOKEN""string"AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the role.
application/json- body
name?stringadministration?unknownpermission?unknowndeletable?booleantrueprops?extendedProps?The answer.
response?stringapplication/jsonThe id.
curl -X PUT "https://platform.example.com/api/admin/role/$ID" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "administration": "...", "permission": "..."}'"string"AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the role.
The answer.
response?stringapplication/jsonThe id.
curl -X PUT "https://platform.example.com/api/admin/role/$ID/restore" \ -H "Authorization: Bearer $TOKEN""string"