URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/serviceAccounts
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único del Proyecto del que se desea recuperar sus cuentas de servicio de la Organización asignadas. Usa la El endpoint /groups para recuperar todos los proyectos a los que tiene acceso el usuario autenticado. |
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). |
| ||||||
elementosPorPágina | entero | Número de elementos a devolver por página, hasta un máximo de 500. |
| ||||||
bonito | booleano | Indica si el cuerpo de la respuesta debe estar en un prettyprint formato. |
| ||||||
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 Para los endpoints que devuelven un resultado, el cuerpo de respuesta incluye:
Para los endpoints que devuelven una lista de resultados, el objeto | Ninguno |
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Documento de respuesta
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 |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en la sección del |
| arreglo | El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web. |
| Número | Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado. |
results embeddedDocument
Cada resultado corresponde a una cuenta de servicio de un proyecto.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único para la cuenta de servicio. |
| fecha y hora | Hora de creación de la cuenta de servicio. |
| string | Nombre de la cuenta de servicio. |
| string | Descripción de la cuenta de servicio. |
| arreglo de string | Lista de roles que la cuenta de servicio tiene en el proyecto. Los roles del proyecto incluyen: |
| objeto arreglo | Lista de secretos de cuentas de servicio. |
| string | string única de 24caracteres hexadecimales que identifica el secreto. |
| fecha y hora | Timestamp que representa la hora de creación del secreto. |
| fecha y hora | Marca de tiempo que representa la fecha de caducidad del secreto. |
| fecha y hora | Marca de tiempo que representa el último uso del secreto. |
| string | Secreto enmascarado que solo muestra el prefijo y los últimos cuatro caracteres. |
Solicitud de ejemplo
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 --include \ 4 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts?pretty=true"
Respuesta de ejemplo
Encabezado de respuesta
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
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 "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 }