Skip to content

Project roles and permissions

RolePermissionsTitleDescription
mongodb-flex.adminmongodb-flex.advisor.listmongodb-flex.backup.clonemongodb-flex.backup.getmongodb-flex.backup.listmongodb-flex.backup.restore-listmongodb-flex.backup.restore-snapshotmongodb-flex.backup.updatemongodb-flex.flavor.listmongodb-flex.instance.createmongodb-flex.instance.deletemongodb-flex.instance.getmongodb-flex.instance.listmongodb-flex.instance.updatemongodb-flex.metric.getmongodb-flex.storage.listmongodb-flex.user.createmongodb-flex.user.deletemongodb-flex.user.getmongodb-flex.user.listmongodb-flex.user.resetmongodb-flex.user.updatemongodb-flex.version.getresource-manager.project.direct.getresource-manager.project.getMongoDB AdminHas admin access in the mongodb-flex domain. Can do anything that editor can.
mongodb-flex.editormongodb-flex.advisor.listmongodb-flex.backup.clonemongodb-flex.backup.getmongodb-flex.backup.listmongodb-flex.backup.restore-listmongodb-flex.backup.restore-snapshotmongodb-flex.backup.updatemongodb-flex.flavor.listmongodb-flex.instance.createmongodb-flex.instance.getmongodb-flex.instance.listmongodb-flex.instance.updatemongodb-flex.metric.getmongodb-flex.storage.listmongodb-flex.user.createmongodb-flex.user.getmongodb-flex.user.listmongodb-flex.user.resetmongodb-flex.user.updatemongodb-flex.version.getresource-manager.project.direct.getresource-manager.project.getMongoDB EditorCan edit resources in the mongodb-flex domain. Can do anything that reader can.
mongodb-flex.readermongodb-flex.advisor.listmongodb-flex.backup.getmongodb-flex.backup.listmongodb-flex.backup.restore-listmongodb-flex.flavor.listmongodb-flex.instance.getmongodb-flex.instance.listmongodb-flex.metric.getmongodb-flex.storage.listmongodb-flex.user.getmongodb-flex.user.listmongodb-flex.version.getresource-manager.project.direct.getresource-manager.project.getMongoDB ReaderCan read any resource in the mongodb-flex domain.
mongodb-flex.user-adminmongodb-flex.advisor.listmongodb-flex.backup.getmongodb-flex.backup.listmongodb-flex.backup.restore-listmongodb-flex.flavor.listmongodb-flex.instance.getmongodb-flex.instance.listmongodb-flex.metric.getmongodb-flex.storage.listmongodb-flex.user.createmongodb-flex.user.deletemongodb-flex.user.getmongodb-flex.user.listmongodb-flex.user.resetmongodb-flex.user.updatemongodb-flex.version.getresource-manager.project.direct.getresource-manager.project.getMongoDB User AdminHas admin access on MongoDB Flex users. Can do anything that reader can.

MongoDB Flex project permission to API mapping

Section titled “MongoDB Flex project permission to API mapping”
PermissionAPI Endpoint/sDescription
mongodb-flex.advisor.list/v1/projects/[projectId]/instances/[instanceId]/advisor/slow-queries (GET)/v1/projects/[projectId]/instances/[instanceId]/advisor/suggested-indexes (GET)Gets slow queries from the Opsmanager performance advisorGets suggested indexes from the Opsmanager performance advisor
mongodb-flex.flavors.list/v1/projects/[projectId]/flavors (GET)Returns all possible flavors
mongodb-flex.instance.list/v1/projects/[projectId]/instances (GET)List all instances for a projectID
mongodb-flex.instance.create/v1/projects/[projectId]/instances (POST)Create and deploys an instance.Note that the time format for the backupSchedule is in UTC
mongodb-flex.instance.delete/v1/projects/[projectId]/instances/[instanceId] (DELETE)Removes an instance
mongodb-flex.instance.get/v1/projects/[projectId]/instances/[instanceId] (GET)Gets information of an instance
mongodb-flex.instance.update/v1/projects/[projectId]/instances/[instanceId] (PUT/PATCH)Updates a deployment plan.Note that the time format for the backupSchedule is in UTC
mongodb-flex.backup.list/v1/projects/[projectId]/instances/[instanceId]/backups (GET)List backups of an instance
mongodb-flex.backup.update/v1/projects/[projectId]/instances/[instanceId]/backups (PUT)Updates a backup schedule.Note that the time format is in UTC
mongodb-flex.backup.get/v1/projects/[projectId]/instances/[instanceId]/backups/[backupId] (GET)Get details about a specific backup
mongodb-flex.backup.clone/v1/projects/[projectId]/instances/[instanceId]/clone (POST)Clone an instance via PIT restore.Note that the Timestamp is a RFC3339 standard and uses by default UTC time format
mongodb-flex.backup.restore-list/v1/projects/[projectId]/instances/[instanceId]/restores (GET)List restore jobs of an instance
mongodb-flex.backup.restore-snapshot/v1/projects/[projectId]/instances/[instanceId]/restores (POST)Restore an instance based on snapshot
mongodb-flex.metrics.get/v1/projects/[projectId]/instances/[instanceId]/metrics/[metric] (GET)Returns metrics depending on the:metric field:CPUDB storageDisk IOPSDisk UsageOperation Execution TimeMemory Metrics
mongodb-flex.users.list/v1/projects/[projectId]/instances/[instanceId]/users (GET)List all users for a mongodb instance
mongodb-flex.user.create/v1/projects/[projectId]/instances/[instanceId]/users (POST)Create a new user for a mongodb instance
mongodb-flex.user.get/v1/projects/[projectId]/instances/[instanceId]/users/[userId] (GET)Get detailed information of a user of a mongodb instance
mongodb-flex.user.delete/v1/projects/[projectId]/instances/[instanceId]/users/[userId] (DELETE)Delete mongodb user
mongodb-flex.user.update/v1/projects/[projectId]/instances/[instanceId]/users/[userId] (PUT/PATCH)Updates user for a mongodb instance
mongodb-flex.user.reset/v1/projects/[projectId]/instances/[instanceId]/users/[userId]/reset (POST)Resets the password for an user
mongodb-flex.storage.list/v1/projects/[projectId]/storages/[flavor] (GET)Returns the storage for a certain flavor
mongodb-flex.version.get/v1/projects/[projectId]/versions (GET)Returns all available versions for creating endpoint