/ /

/ /

Asignar una cuenta de servicio de organización al proyecto

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

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

Resource

POST /groups/{PROJECT-ID}/serviceAccounts/{CLIENT-ID}:invite

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
`PROJECT-ID`	string	Identificador único del proyecto cuyas cuentas de servicio desea actualizar. Utilice el /groups punto final para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.
`CLIENT-ID`	string	Identificador único de la cuenta de servicio que deseas actualizar. Solicite el endpoint /groups/{PROJECT-ID}/serviceAccounts para recuperar todas las cuentas de servicio a las que el usuario autenticado tenga acceso para la organización especificada.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Descripción

predeterminado

Num. de pág.

entero

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

1

elementosPorPágina

entero

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

100

bonito

booleano

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

false

envelope

booleano

Indica si se debe o no envolver 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 endpoints que devuelven un resultado, el cuerpo de respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`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

Nombre

Tipo

Necesidad

Descripción

roles

arreglo

Requerido

Lista de roles que se debe conceder 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 de Rol en 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`

Respuesta

Elementos de respuesta

Si establece el elemento de consulta envelope en true, la respuesta estará envuelta por el objeto content.

La respuesta HTTP retorna un documento JSON que incluye los siguientes objetos:

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`	arreglo de string	Lista de roles que la cuenta de servicio tiene 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`	objeto arreglo	Lista de secretos de cuentas de servicio.
`secrets.id`	string	string única de 24caracteres hexadecimales que identifica el secreto.
`secrets.createdAt`	fecha y hora	Timestamp que representa la hora de creación del secreto.
`secrets.expiresAt`	fecha y hora	Marca de tiempo que representa la fecha de caducidad 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.

Solicitud de ejemplo

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

Respuesta de ejemplo

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}

Respuesta del cuerpo

1 {
2   "createdAt" : "2024-08-03T14:02:40Z",
3   "description" : "Service account for developers.",
4   "clientId" : "mdb_sa_id_66ae38803cdf55582cb01144",
5   "name" : "Dev Service Account",
6   "roles" : [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ],
7   "secrets" : [ {
8     "createdAt" : "2024-08-03T14:02:40Z",
9     "expiresAt" : "2024-12-31T14:02:40Z",
10     "id" : "66ae38803cdf55582cb01143",
11     "lastUsedAt" : "2024-08-24T21:10:35Z",
12     "maskedSecretValue" : "mdb_sa_sk_...hcOL"
13   } ]
14 }

Volver

Crear y asignar

Modificar detalles

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

1	{
2	"createdAt" : "2024-08-03T14:02:40Z",
3	"description" : "Service account for developers.",
4	"clientId" : "mdb_sa_id_66ae38803cdf55582cb01144",
5	"name" : "Dev Service Account",
6	"roles" : [ "GROUP_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE" ],
7	"secrets" : [ {
8	"createdAt" : "2024-08-03T14:02:40Z",
9	"expiresAt" : "2024-12-31T14:02:40Z",
10	"id" : "66ae38803cdf55582cb01143",
11	"lastUsedAt" : "2024-08-24T21:10:35Z",
12	"maskedSecretValue" : "mdb_sa_sk_...hcOL"
13	} ]
14	}