Skip to main content

Security & Users

Manage users, roles, permissions, and SSL certificates.

See also: Security & Users documentation | Full API Reference for interactive testing and complete schemas.

Endpoints

MethodPathDescriptionReference
GET/certificate-authority-service/certificatesList all certificates managed by the internal certificate authorityAPI Reference →
GET/certificate-authority-service/detailsGet details about the internal certificate authorityAPI Reference →
POST/certificate-authority-service/issueIssue a new certificate from the internal certificate authorityAPI Reference →
POST/certificate-authority-service/renewRenew a certificate via the internal certificate authorityAPI Reference →
POST/certificate-authority-service/updateUpdate the internal certificate authority configurationAPI Reference →
GET/certificate-service/certificatesList all SSL/TLS certificates installed in MangoAPI Reference →
POST/certificate-service/csrGenerate a Certificate Signing Request (CSR)API Reference →
POST/certificate-service/installInstall an SSL/TLS certificateAPI Reference →
POST/certificate-service/renewRenew the current SSL/TLS certificateAPI Reference →
POST/certificate-service/renewal-csrGenerate a CSR for certificate renewalAPI Reference →
POST/certificate-service/updateUpdate SSL/TLS certificate configurationAPI Reference →
GET/rolesQuery RolesAPI Reference →
POST/rolesCreate a RoleAPI Reference →
DELETE/roles/{xid}Delete a RoleAPI Reference →
GET/roles/{xid}Get a RoleAPI Reference →
PATCH/roles/{xid}Partially update a RoleAPI Reference →
PUT/roles/{xid}Update a Role ListAPI Reference →
GET/system-permissionsQuery permissions, their names and rolesAPI Reference →
GET/system-permissions/{name}Get a permissionAPI Reference →
PUT/system-permissions/{name}Update all of a Permission's RolesAPI Reference →
GET/usersGets a list of users for bulk import via CSVAPI Reference →
POST/usersCreate UserAPI Reference →
DELETE/users/{username}Delete a userAPI Reference →
GET/users/{username}Get User by usernameAPI Reference →
PATCH/users/{username}Partially update a UserAPI Reference →
PUT/users/{username}Update UserAPI Reference →
PUT/users/{username}/homepageUpdate a user's home urlAPI Reference →
PUT/users/{username}/lock-passwordLocks a user's passwordAPI Reference →
PUT/users/{username}/muteUpdate a user's audio mute settingAPI Reference →
POST/users/approve-usersApprove publicly registered User(s)API Reference →
GET/users/bulkGet a list of current bulk user operationsAPI Reference →
POST/users/bulkBulk get/create/update/delete usersAPI Reference →
DELETE/users/bulk/{id}Remove a bulk user operation using its idAPI Reference →
GET/users/bulk/{id}Get the status of a bulk user operation using its idAPI Reference →
PUT/users/bulk/{id}Update a bulk user operation using its idAPI Reference →
GET/users/currentGet current userAPI Reference →
GET/users/exportExport formatted for Configuration Import by supplying an RQL queryAPI Reference →
GET/users/export/{usernames}Export user(s) formatted for Configuration ImportAPI Reference →
GET/users/linked-accounts/{username}Get OAuth/SSO linked accounts for a userAPI Reference →
PUT/users/linked-accounts/{username}Update OAuth/SSO linked accounts for a userAPI Reference →
POST/users/queryGets a list of users for bulk import via CSVAPI Reference →