URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /orgs/{ORG-ID}/serviceAccounts
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | El identificador único para el Organización cuya cuenta de servicio desea recuperar. Utilice el punto de conexión /orgs para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
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). |
| ||||||
artículos por página | entero | Número de artículos a devolver por página, hasta un máximo de 500. |
| ||||||
bonita | booleano | Indica si el cuerpo de la respuesta debe estar en formato prettyprint. formato. |
| ||||||
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 Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:
Para los endpoints que devuelven una lista de resultados, el objeto | Ninguno |
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 | La matriz incluye un objeto para cada elemento detallado en la |
| 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. |
| 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. |
results Documento incrustado
Cada resultado es una cuenta de servicio.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único para la cuenta de servicio. |
| string | Descripción de la cuenta de servicio. Los caracteres aceptados son |
| string | Nombre de la cuenta de servicio. Los caracteres aceptados son |
| fecha y hora | Hora de creación de la cuenta de servicio. |
| matriz de objetos | Lista de secretos de cuentas de servicio. |
| string | Cadena de caracteres hexadecimales 24única que identifica el secreto. |
| string | Secreto de cuenta de servicio, disponible solo en el momento de su creación. |
| string | Secreto enmascarado que solo muestra el prefijo y los últimos cuatro caracteres. |
| fecha y hora | Marca de tiempo que representa la hora de creación del secreto. |
| fecha y hora | Marca de tiempo que representa el último uso del secreto. |
| fecha y hora | Marca de tiempo que representa el tiempo de expiración del secreto. |
| matriz de objetos | Roles que tiene la cuenta de servicio en la organización. Los roles de la organización incluyen: |
Ejemplo de solicitud
Nota
El usuario que realiza la solicitud puede tener el formato {PUBLIC-KEY}:{PRIVATE-KEY}.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/serviceAccounts?pretty=true"
Ejemplo de respuesta
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}
Cuerpo de respuesta
{ "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/orgs/1234567890abcdef12345678/serviceAccounts?pretty=true&pageNum=1&itemsPerPage=3", "rel": "self" } ], "results": [ { "createdAt": "2024-04-23T20:36:22Z", "description": "Service account for development team", "clientId": "mdb_sa_id_001", "name": "dev-team-sa", "roles": ["ORG_OWNER"], "secrets": [ { "createdAt": "2024-04-23T20:36:22Z", "expiresAt": "2024-12-01T00:00:00Z", "id": "secret_id_001", "lastUsedAt": "2024-04-23T20:49:19Z", "maskedSecretValue": "mdb_sa_sk_…OEyV" } ] }, { "createdAt": "2024-05-31T17:27:05Z", "description": "Service account for billing operations", "clientId": "mdb_sa_id_002", "name": "billing-sa", "roles": ["ORG_BILLING_ADMIN"], "secrets": [ { "createdAt": "2024-05-31T17:27:05Z", "expiresAt": "2025-05-31T17:27:05Z", "id": "secret_id_002", "maskedSecretValue": "mdb_sa_sk_…OTyG" } ] }, { "createdAt": "2024-06-04T18:31:42Z", "description": "Service account for project management", "clientId": "mdb_sa_id_003", "name": "project-mgmt-sa", "roles": ["ORG_MEMBER"], "secrets": [ { "createdAt": "2024-06-04T18:31:42Z", "expiresAt": "2024-09-02T18:31:42Z", "id": "secret_id_003", "maskedSecretValue": "mdb_sa_sk_…OWyP" } ] } ], "totalCount": 3 }