Get Access List for the Current User
On this page
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /users/{USER-ID}/accessList
Request Path Parameters
Parameter | Type | Description |
|---|---|---|
USER-ID | string | (Required.) User Unique identifier of the current user. To retrieve the ID
of the current user, see
Get All Users in One Project. |
Request Query Parameters
The following query parameters are optional:
Name | Type | Necessity | Description | Default |
|---|---|---|---|---|
pageNum | number | Optional | One-based integer that returns a subsection of results. | 1 |
itemsPerPage | number | Optional | Number of items to return per page, up to a maximum of 500. | 100 |
pretty | boolean | Optional | Flag that indicates whether the response body should be in a
prettyprint format. | false |
envelope | boolean | Optional | Flag that 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 For endpoints that return a list of results, the | false |
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.
Name | Type | Description |
|---|---|---|
cidrBlock | string | A CIDR-notated range of IP addresses. |
created | date | The date this IP address was added to the access list. |
ipAddress | string | An IP address in the access list. |
lastUsed | date | The date of the most recent request that originated from this IP
address. Note that this field is only updated when a resource that is
protected by the access list is accessed. |
lastUsedAddress | string | The address from which the last call to the API was issued. |
count | number | The total number of requests that originated from this IP address.
Note that this field is only updated when a resource that is
protected by the access list is accessed. |
links | array | Links to related sub-resources. All links arrays in responses
contain at least one link called self. The relations between
URLs are explained in the Web Linking Specification. |
Example Request
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<ops-manager-host>/api/public/v1.0/users/{USER-ID}/accessList"
Example Response
Response Header
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
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
{ "results" : [ { "cidrBlock" : "5.6.7.8/30", "count" : 482, "created" : "2014-04-23T16:17:44Z", "lastUsed" : "2016-04-19T14:15:52Z", "lastUsedAddress" : "5.6.7.7", "links" : [] }, { "cidrBlock" : "1.2.3.4/32", "count" : 9, "created" : "2016-02-19T14:46:14Z", "ipAddress" : "1.2.3.4", "lastUsed" : "2016-04-25T15:42:50Z", "lastUsedAddress" : "1.2.3.4", "links" : [] } ], "totalCount" : 2, "links" : [] }