- API >
- Public API Resources >
- Groups and Users >
- User API Keys >
- Get All API Keys for User
Get All API Keys for User¶
On this page
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
This endpoint retrieves the 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 user this endpoint. See Generate Public API Keys for instructions.
Resource¶
Request Parameters¶
Request Path Parameters¶
Path Element | Required/Optional | Description |
---|---|---|
USER-ID |
Required. | The 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 |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.
Name | Type | Description | Default |
---|---|---|---|
pageNum | integer | Page number (1-based). | 1 |
itemsPerPage | integer | Maximum number of items to return, up to a maximum of 100. | 100 |
pretty | boolean | Indicates whether the response body should be in a prettyprint format. | 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 For endpoints that return a list of results, the |
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 |
object array | This array includes one object for each item detailed in the results Embedded Document section. |
links |
object array | This 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 |
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 API key.
Name | Type | Description |
---|---|---|
createdAt |
timestamp | The time the API key was created. |
description |
string | Description of the API key. |
enabled |
boolean | Indicates whether the API key is enabled. |
id |
string | The unique identifier of the API key. |
lastUsed |
string | The ISO8601 timestamp representing the date and time the API key was last used. |
obfuscatedKey |
string | The obfuscated API key. Ops Manager only displays the full API key immediately after key creation. |
usedCount |
number | The number of times that the API key has been used by the associated user. |
userId |
string | The user ID associated with the API key. |