Docs Menu
Docs Home
/ /

Asignar todas las cuentas de servicio de la organización a un proyecto

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

GET /groups/{PROJECT-ID}/serviceAccounts
Nombre
Tipo
Descripción

PROJECT-ID

string

Identificador único del proyecto del que desea recuperar las cuentas de servicio de la organización asignadas. Utilice el /groups punto final para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

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

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

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.

Nombre
Tipo
Descripción

results

arreglo

La matriz incluye un objeto para cada elemento detallado en la results sección Documento incrustado.

links

arreglo

La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.

totalCount

Número

Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado.

Cada resultado es una cuenta de servicio del proyecto.

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:

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.

Nota

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

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --include \
4 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts?pretty=true"
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}
1{
2 "links": [
3 {
4 "href": "https://cloud.mongodb.com/api/public/v1.0/groups/66ae30345fe4416479e39269/serviceAccounts?pretty=true&pageNum=1&itemsPerPage=100",
5 "rel": "self"
6 }
7 ],
8 "results": [
9 {
10 "createdAt": "2024-08-03T14:02:40Z",
11 "description": "Service account for Cloud Manager users.",
12 "clientId": "mdb_sa_id_66ae38803cdf55582cb01144",
13 "name": "General Access",
14 "roles": ["GROUP_DATA_ACCESS_ADMIN", "GROUP_READ_ONLY"],
15 "secrets": [
16 {
17 "createdAt": "2024-08-03T14:02:40Z",
18 "expiresAt": "2024-12-31T14:02:40Z",
19 "lastUsedAt" : "2024-08-24T21:10:35Z",
20 "id": "66ae38803cdf55582cb01143",
21 "maskedSecretValue": "mdb_sa_sk_...hcOL"
22 }
23 ]
24 },
25 {
26 "createdAt": "2024-08-03T14:05:20Z",
27 "description": "Service account for read access.",
28 "clientId": "mdb_sa_id_66ae38803cdf55582cb01145",
29 "name": "Read Only Access",
30 "roles": ["GROUP_READ_ONLY"],
31 "secrets": [
32 {
33 "createdAt": "2024-08-03T14:05:20Z",
34 "expiresAt": "2024-12-31T14:05:20Z",
35 "lastUsedAt" : "2024-08-24T21:10:35Z",
36 "id": "66ae38803cdf55582cb01146",
37 "maskedSecretValue": "mdb_sa_sk_...jcOP"
38 }
39 ]
40 },
41 {
42 "createdAt": "2024-08-03T14:10:00Z",
43 "description": "Service account for data backup.",
44 "clientId": "mdb_sa_id_66ae38803cdf55582cb01147",
45 "name": "Backup Access",
46 "roles": ["GROUP_DATA_BACKUP_ADMIN"],
47 "secrets": [
48 {
49 "createdAt": "2024-08-03T14:10:00Z",
50 "expiresAt": "2024-12-31T14:10:00Z",
51 "lastUsedAt" : "2024-08-24T21:10:35Z",
52 "id": "66ae38803cdf55582cb01148",
53 "maskedSecretValue": "mdb_sa_sk_...kcQR"
54 }
55 ]
56 }
57 ],
58 "totalCount": 3
59}

Volver

Cuentas del proyecto

En esta página