Get All Roles for Global API Keys¶

On this page

Resource
Required Roles
Request Parameters
- Request Path Parameters
- Request Query Parameters
Response
Example Request
Example Response
- Response Header
- Response Body

Return a list of acceptable Global Roles for Global API Keys.

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

Resource¶

GET /admin/apiKeys/roles

Required Roles¶

Requires that the API Key calling this endpoint have the Global Read Only role.

Request Parameters¶

Request Path Parameters¶

This endpoint does not use HTTP request path parameters.

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 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 "envelope" : true in the query.

For endpoints that return one result, response body includes:

status	HTTP response code
envelope	Expected response body

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

None

Response¶

Returns an array of all of the acceptable Global Roles for the Global API Keys.

Example Request¶

Note

The user who makes the request can be formatted either as {USERNAME}:{APIKEY} or {PUBLIC-KEY}:{PRIVATE-KEY}.

copy

curl --user "{USERNAME}:{APIKEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/roles?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¶

{
  [
    "GLOBAL_BACKUP_ADMIN",
    "GLOBAL_BILLING_ADMIN",
    "GLOBAL_MONITORING_ADMIN",
    "GLOBAL_READ_ONLY",
    "GLOBAL_AUTOMATION_ADMIN",
    "GLOBAL_USER_ADMIN"
  ]
}

← Get All Global API Keys Get One Global API Key →