API >
Public API Resources >
API Keys >
Assign One Organization API Key to One Project

Assign One Organization API Key to One Project¶

On this page

Resource
Response
Example Request
Example Response
- Response Header
- Response Body

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

Resource¶

POST /groups/{GROUP-ID}/apiKeys/{API-KEY-ID}

Request Path Parameters¶

Name	Type	Description
`GROUP-ID`	string	Unique identifier for the Project whose API keys you want to update. Use the /groups endpoint to retrieve all organizations to which the authenticated user has access.
`API-KEY-ID`	string	Unique identifier for the API key you want to update. Use the /groups/{GROUP-ID}/apiKeys endpoint to retrieve all API keys to which the authenticated user has access for the specified organization.

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 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

Request Body Parameters¶

The body parameter is required.

Name Type Necessity Description

roles

string array

Required

List of roles that the API Key should be granted. A minimum of one role must be provided. Any roles provided must be valid for the assigned Project:

Role Value in API	Role
`GROUP_AUTOMATION_ADMIN`	Project Automation Admin
`GROUP_BACKUP_ADMIN`	Project Backup Admin
`GROUP_CHARTS_ADMIN`	Project Charts Admin
`GROUP_DATA_ACCESS_ADMIN`	Project Data Access Admin
`GROUP_DATA_ACCESS_READ_ONLY`	Project Data Access Read Only
`GROUP_DATA_ACCESS_READ_WRITE`	Project Data Access Read/Write
`GROUP_MONITORING_ADMIN`	Project Monitoring Admin
`GROUP_OWNER`	Project Owner
`GROUP_READ_ONLY`	Project Read Only
`GROUP_USER_ADMIN`	Project User Admin

This returns a noContent response (a 204) with an empty body.

Response¶

Example Request¶

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --include \
  --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/5953c5f380eef53887615f9a/apiKeys/5d1d12c087d9d63e6d682438"

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 204 No Content
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body¶

This endpoint does not return a response body.

← Create and Assign One Organization API Key to One Project Modify Roles of One Organization API Key to One Project →