/ /

/ /

Modificar detalles de una cuenta de servicio del proyecto

Cloud Manager dejará de ofrecer compatibilidad con automatización, copias de seguridad y monitorización para MongoDB 3.6 y 4.0 a partir del 30de agosto de 2024. Por favor, Actualice su implementación de MongoDB o migre a Atlas.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

PATCH /groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
`PROJECT-ID`	string	Identificador único del proyecto cuya cuenta de servicio desea actualizar. Utilice el /groups punto final para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
`CLIENT-ID`	string	Identificador único de la cuenta de servicio que desea actualizar. Solicite al punto de conexión /groups/{PROJECT-ID}/serviceAccounts que recupere todas las cuentas de servicio a las que el usuario autenticado tiene acceso para el proyecto especificado.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Descripción

predeterminado

número de página

entero

Número de página (basado en el índice 1).

1

artículos por página

entero

Número de artículos a devolver por página, hasta un máximo de 500.

100

bonita

booleano

Indica si el cuerpo de la respuesta debe estar en formato prettyprint. formato.

false

envolvente

booleano

Indica si se debe envolver o no la respuesta en un sobre.

Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure "envelope" : true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuestaHTTP
`content`	Cuerpo de respuesta esperado

Para los endpoints que devuelven una lista de resultados, el objeto results es un sobre. Cloud Manager añade el campo status al cuerpo de la respuesta.

Ninguno

Parámetros del cuerpo de la solicitud

El parámetro del cuerpo es obligatorio.

Nombre

Tipo

Necesidad

Descripción

name

string

Opcional

Nombre de la cuenta de servicio. Los caracteres aceptados son A-Z, a-z, 0-9, espacio, punto ., apóstrofe ', coma ,, guión bajo _ y guión -.

description

string

Opcional

Descripción de la cuenta de servicio. Los caracteres aceptados son A-Z, a-z, 0-9, espacio, punto ., apóstrofo ', coma ,, guion bajo _ y guion -.

roles

matriz de cadenas

Requerido

Lista de roles que se deben asignar a la cuenta de servicio. Se debe proporcionar al menos un rol. Todos los roles proporcionados deben ser válidos para el proyecto asignado:

Valor del rol en la API	rol
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup 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`

Incluya todos los roles que desea que tenga esta cuenta de servicio. Se eliminarán los roles que no estén en esta matriz.

Respuesta

Nombre	Tipo	Descripción
`clientId`	string	Identificador único para la cuenta de servicio.
`createdAt`	fecha y hora	Hora de creación de la cuenta de servicio.
`name`	string	Nombre de la cuenta de servicio.
`description`	string	Descripción de la cuenta de servicio.
`roles`	matriz de cadenas	Lista de roles que tiene la cuenta de servicio en el proyecto. Los roles del proyecto incluyen: `GROUP_AUTOMATION_ADMIN` `GROUP_BACKUP_ADMIN` `GROUP_DATA_ACCESS_ADMIN` `GROUP_DATA_ACCESS_READ_ONLY` `GROUP_DATA_ACCESS_READ_WRITE` `GROUP_MONITORING_ADMIN` `GROUP_OWNER` `GROUP_READ_ONLY` `GROUP_USER_ADMIN`
`secrets`	matriz de objetos	Lista de secretos de cuentas de servicio.
`secrets.id`	string	Cadena de caracteres hexadecimales 24única que identifica el secreto.
`secrets.createdAt`	fecha y hora	Marca de tiempo que representa la hora de creación del secreto.
`secrets.expiresAt`	fecha y hora	Marca de tiempo que representa el tiempo de expiración del secreto.
`secrets.lastUsedAt`	fecha y hora	Marca de tiempo que representa el último uso del secreto.
`secrets.maskedSecretValue`	string	Secreto enmascarado que solo muestra el prefijo y los últimos cuatro caracteres.

Ejemplo de solicitud

Nota

El usuario que realiza la solicitud puede tener el formato {PUBLIC-KEY}:{PRIVATE-KEY}.

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}?pretty=true" \
6      --data '{
7          "roles": [ "GROUP_OWNER" ]
8        }'

Ejemplo de respuesta

Encabezado de respuesta

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}

Cuerpo de respuesta

1 {
2   "createdAt" : "2024-08-04T01:16:21Z",
3   "description" : "Service account for Cloud Manager users.",
4   "clientId" : "mdb_sa_id_66aed6653e07126244a84cc1",
5   "name" : "Cloud Manager service account",
6   "roles" : [ "GROUP_OWNER" ],
7   "secrets" : [ {
8     "createdAt" : "2024-08-04T01:16:21Z",
9     "expiresAt" : "2024-11-02T01:16:21Z",
10     "lastUsedAt" : "2024-08-24T21:10:35Z",
11     "id" : "66aed6653e07126244a84cc0",
12     "maskedSecretValue" : "mdb_sa_sk_...MeyM"
13   } ]
14 }

Volver

Asignar

Unassign

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}?pretty=true" \
6	--data '{
7	"roles": [ "GROUP_OWNER" ]
8	}'

1	{
2	"createdAt" : "2024-08-04T01:16:21Z",
3	"description" : "Service account for Cloud Manager users.",
4	"clientId" : "mdb_sa_id_66aed6653e07126244a84cc1",
5	"name" : "Cloud Manager service account",
6	"roles" : [ "GROUP_OWNER" ],
7	"secrets" : [ {
8	"createdAt" : "2024-08-04T01:16:21Z",
9	"expiresAt" : "2024-11-02T01:16:21Z",
10	"lastUsedAt" : "2024-08-24T21:10:35Z",
11	"id" : "66aed6653e07126244a84cc0",
12	"maskedSecretValue" : "mdb_sa_sk_...MeyM"
13	} ]
14	}