Atualizar uma chave de API global

Nesta página

Resource

Funções obrigatórias
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

O MongoDB Ops Manager v6.0 será EOL em janeiro 2025. Atualize para uma versão superior do MongoDB Ops Manager o mais rápido possível.

Atualize os valores de uma chave deAPI global do Ops Manager usando o identificador exclusivo para essa chave.

Para localizar uma Chave de API Global específica, obtenha a lista de Chaves de API Global e, em seguida, encontre o {API-KEY-ID} que precisa.

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

Resource

PATCH /admin/apiKeys/{API-KEY-ID}

Funções obrigatórias

Exige que a chave de API que chama esse endpoint tenha a role Global Owner .

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Todos os parâmetros do caminho da solicitação são obrigatórios.

Nome	Tipo	Descrição
`API-KEY-ID`	string	Identificador exclusivo da chave de API global que você deseja atualizar.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome

Tipo

necessidade

Descrição

Default

pretty

booleano

Opcional

Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato.

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome	Descrição
Status	Código de resposta HTTP
envelope	Corpo de resposta esperado

false

Parâmetros do corpo da solicitação

Você deve fornecer um ou ambos os dois parâmetros do corpo.

Nome

Tipo

necessidade

Descrição

desc

string

Condicional

Descrição da chave. Este parâmetro é opcional; no entanto, a solicitação deve conter um parâmetro desc ou um parâmetro roles . Se desc for fornecido, ele deverá ter entre 1 e 250 caracteres.

roles

array de strings

Condicional

Lista de funções que a chave de API global precisa ter. Se a matriz roles for fornecida:

Forneça pelo menos um role
Certifique-se de que todos os papéis são válidos.

As funções globais aceitas por padrão incluem:

Valor da função na API	Função
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

Resposta

Nome

Tipo

Descrição

desc

string

Descrição desta chave de API global.

id

string

Identificador exclusivo para esta chave de API global.

links

string

Uma array de documentos, representando um link para um ou mais sub-recursos e/ou recursos relacionados, como paginação de lista. Consulte Vinculação para obter mais informações.

privateKey

string

Chave privada editada para esta chave de API global.

publicKey

string

Chave pública para esta chave de API global.

roles

array de objetos

Funções que esta chave de API global tem. Essa matriz retorna todos os roles globais que o usuário tem no Ops Manager.

roles.roleName

string

Nome da função. Esse recurso retorna todos os roles que o usuário tem no Ops Manager. Os valores possíveis são:

Valor da função na API	Função
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

Exemplo de solicitação

Observação

O usuário que faz a solicitação pode ser formatado como {USERNAME}:{APIKEY} ou {PUBLIC-KEY}:{PRIVATE-KEY}.

1 curl --user "{USERNAME}:{APIKEY}" --digest \
2   --header "Accept: application/json" \
3   --header "Content-Type: application/json" \
4   --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true" \
5   --data '{
6     "desc" : "Updated API key description for test purposes"
7   }'

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

1 {
2   "created": "2019-09-04T15:37:40Z",
3   "desc": "Updated API key description for test purposes",
4   "globalRoles": ["GLOBAL_READ_ONLY"],
5   "groupRoles": [],
6   "numGroups": 0,
7   "orgRoles": [],
8   "orgRolesString": "",
9   "privateKey": "********-****-****-cfe60e9f1f72",
10   "userId": "5d6fda44ff4ab7133648a852",
11   "username": "dczverfw"
12 }

Voltar

Criar uma chave de API global

Excluir uma chave de API global

1	curl --user "{USERNAME}:{APIKEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true" \
5	--data '{
6	"desc" : "Updated API key description for test purposes"
7	}'

1	{
2	"created": "2019-09-04T15:37:40Z",
3	"desc": "Updated API key description for test purposes",
4	"globalRoles": ["GLOBAL_READ_ONLY"],
5	"groupRoles": [],
6	"numGroups": 0,
7	"orgRoles": [],
8	"orgRolesString": "",
9	"privateKey": "******--**-cfe60e9f1f72",
10	"userId": "5d6fda44ff4ab7133648a852",
11	"username": "dczverfw"
12	}