Get All API Keys for User¶

On this page

Resource
Request Parameters
Response
Example Request
Example Response

Important

Ops Manager deprecated Personal API Keys. Use Programmatic API Keys instead.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

This endpoint retrieves the personal API keys for a specific Ops Manager user. You must be one of the following users to successfully call this endpoint:

The Ops Manager user specified in the digest authentication
The Ops Manager user with the GLOBAL_OWNER role

Note

You must have access to an a public API key generated from the GUI by your administrator before you can successfully use this endpoint. See Manage Personal API Keys (Deprecated) for instructions.

Resource¶

copy

GET /users/{USER-ID}/keys

Request Parameters¶

Request Path Parameters¶

Path Element Necessity Description

USER-ID

Required

Unique identifier for your Ops Manager user.

Use the /users/byName/{USER-NAME} endpoint to retrieve your user ID. Your user ID corresponds to the id field returned in the response from that endpoint.

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 `envelope : true` in the query. For endpoints that return a list of results, the `results` object is an envelope. Ops Manager adds the `status` field to the response body.	`false`

Request Body Parameters¶

This endpoint does not 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 element in the results array is one personal API key.

Name	Type	Description
`createdAt`	timestamp	Timestamp in ISO 8601 date and time format in UTC when the personal API key was created.
`description`	string	Description of the personal API key.
`enabled`	boolean	Flag that indicates whether the personal API key is enabled.
`id`	string	Unique identifier of the personal API key.
`lastUsed`	string	Timestamp in ISO 8601 date and time format in UTC when the personal API key was last used.
`obfuscatedKey`	string	Obfuscated API key. Ops Manager displays the full personal API key immediately after key creation only.
`usedCount`	number	Number of times that the personal API key has been used by the associated user.
`userId`	string	Unique identifer of the user associated with the personal API key.

Example Request¶

copy

curl --digest --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}/keys/"

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¶

copy

{
  "links": [
    {
      "href": "https://{ops-manager-host}:{port}/api/public/v1.0/users/{USER-ID}/keys?pageNum=1&itemsPerPage=100",
      "rel": "self"
    }
  ],
  "results": [
    {
      "createdAt": "2018-05-14T14:45:22Z",
      "description": "Staging Application",
      "enabled": true,
      "id": "5af9a1d29cc0cdb6acdca6d5",
      "lastUsed": "2018-05-14T14:45:23Z",
      "obfuscatedKey": "********-****-****-92732876eeae",
      "usedCount": 7,
      "userId": "{USER-ID}"
    },
    {
      "createdAt": "2017-02-02T21:35:06Z",
      "description": "Production Application",
      "enabled": true,
      "id": "5af9a1d29cc0cdb6acce1c30",
      "lastUsed": "2018-05-14T14:45:47Z",
      "obfuscatedKey": "********-****-****-4c5d3fc98d30",
      "usedCount": 69,
      "userId": "{USER-ID}"
    }
  ],
  "totalCount": 2
}

← Personal API Keys (Deprecated) Enable/Disable a User API Key →