Docs Menu
Docs Home
/
MongoDB Cloud Manager

Get All Access List Entries for One Project Service Account

On this page

  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Response Document
  • results Embedded Document
  • Example Request
  • Example Response
  • Response Header
  • Response Body

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

Retrieve information on all access list entries for the specified service account.

Resource

GET /groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}/accessList

Request Path Parameters

Name
Type
Description
PROJECT-ID
string
Unique identifier for the Project to which the target service account belongs. Use the /groups endpoint to retrieve all Projects to which the authenticated user has access.
CLIENT-ID
string
Unique identifier for the service account you want to create a secret for. Use the /groups/{PROJECT-ID}/serviceAccounts endpoint to retrieve all service accounts to which the authenticated user has access for the specified Project.

Request Query Parameters

The following query parameters are optional:

Name
Type
Description
Default
pageNum
integer
Page number (1-index based).
1
itemsPerPage
integer
Number of items to return per page, up to a maximum of 500.
100
pretty
boolean
false
envelope
boolean

Indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set "envelope" : true in the query.

For endpoints that return one result, response body includes:

Name
Description
status
HTTP response code
content
Expected response body

For endpoints that return a list of results, the results object is an envelope. Cloud Manager adds the status field to the response body.

None

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response

Response Document

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name
Type
Description
results
array
Array includes one object for each item detailed in the results Embedded Document section.
links
array
Array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
totalCount
number
Integer count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results Embedded Document

Each result is one access list entry.

Name
Type
Description
cidrBlock
string
CIDR-notated range of IP addresses in the access list.
requestCount
number
Total number of requests that have originated from this IP address.
createdAt
date
Date this IP address was added to the access list.
ipAddress
string
IP address in the access list.
lastUsedAt
date
Date of the most recent request that originated from this IP address. This field only appears if at least one request has originated from this IP address, and is only updated when a resource is retrieved from the access list.
lastUsedAddress
string
IP address from which the last call to the API was issued. This field only appears if at least one request has originated from this IP address.
links
array
An array of documents, representing a link to one or more sub-resources and/or related resources such as list pagination. See Linking for more information.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}/accessList?pretty=true"

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

1{
2  "links" : [ {
3  "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}/accessList/?pretty=true&pageNum=1&itemsPerPage=100",
4  "rel" : "self"
5  } ],
6  "results" : [ {
7    "cidrBlock" : "147.58.184.16/32",
8    "requestCount" : 0,
9    "createdAt" : "2019-01-24T16:34:57Z",
10    "ipAddress" : "147.58.184.16",
11    "lastUsed" : "2019-01-24T20:18:25Z",
12    "lastUsedAddress": "147.58.184.16"
13  }, {
14    "cidrBlock" : "84.255.48.125/32",
15    "requestCount" : 0,
16    "createdAt" : "2019-01-24T16:26:37Z",
17    "ipAddress" : null,
18    "lastUsed" : "2019-01-24T20:18:25Z",
19    "lastUsedAddress": "84.255.48.125"
20  } ],
21  "totalCount" : 2
22}

Next

MongoDB Cloud Manager