Get a Single Custom MongoDB Role¶

On this page

Syntax
Examples
- Request
- Response

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

The Atlas API uses HTTP Digest Authentication. Provide your Atlas username and API key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

Syntax¶

copy

GET /api/atlas/v1.0/groups/{GROUP-ID}/customDBRoles/roles/{ROLE-NAME}

Request Path Parameters¶

Parameter	Required/Optional	Description
`GROUP-ID`	Required.	The unique identifier for the project.
`ROLE-NAME`	Required.	The name of the role to retrieve.

Request Query Parameters¶

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name	Type	Description	Default
`pretty`	boolean	Displays response in a prettyprint format.	`false`
`envelope`	boolean	Specifies whether or not to wrap the response in an envelope.	`false`

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response Elements¶

If you set the query element envelope to true, the response is wrapped by the content object.

Name	Type	Description
`actions`	array	Each object in the `actions` array represents an individual privilege action granted by the role.
`actions.action`	string	Name of the privilege action.
`actions.resources`	array	Contains information on where the action is granted. Each object in the array either indicates a database and collection on which the action is granted, or indicates that the action is granted on the cluster resource.
`actions.resources.collection`	string	Collection on which the action is granted. If this value is an empty string, the action is granted on all collections within the database specified in the `actions.resources.db` field. Note This field is mutually exclusive with the `actions.resources.cluster` field.
`actions.resources.db`	string	Database on which the action is granted. Note This field is mutually exclusive with the `actions.resources.cluster` field.
`actions.resources.cluster`	boolean	Set to `true` to indicate that the action is granted on the cluster resource. Note This field is mutually exclusive with the `actions.resources.collection` and `actions.resources.db` fields.
`inheritedRoles`	array	Each object in the `inheritedRoles` array represents a key-value pair indicating the inherited role and the database on which the role is granted.
`inheritedRoles.db`	string	Database on which the inherited role is granted.
`inheritedRoles.role`	string	Name of the inherited role. This can either be another custom role or a built-in role.
`roleName`	string	Name of the custom role.

Examples¶

Request¶

Important

You must modify the following code block with the appropriate credentials and project ID.

copy

curl --user '{USERNAME}:{APIKEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/customDBRoles/roles/ShardingAdmin?pretty=true"

Response¶

copy

HTTP/1.1 200 OK

{
  "actions" : [ {
    "action" : "LIST_SESSIONS",
    "resources" : [ {
      "cluster" : true
    } ]
  }, {
    "action" : "KILL_ANY_SESSION",
    "resources" : [ {
      "cluster" : true
    } ]
  }, {
    "action" : "USE_UUID",
    "resources" : [ {
      "cluster" : true
    } ]
  }, {
    "action" : "COLL_STATS",
    "resources" : [ {
      "collection" : "",
      "db" : "staging"
    } ]
  } ],
  "inheritedRoles" : [ {
    "db" : "admin",
    "role" : "enableSharding"
  }, {
    "db" : "admin",
    "role" : "backup"
  } ],
  "roleName" : "ShardingAdmin"
}

← Get All Custom MongoDB Roles in a Project Create a Custom MongoDB Role →