/ /

Cuentas de la organización

Docs Home

/ /

Cuentas de servicio

Cuentas de la organización

Cuentas de la organización

Obtenga una cuenta de servicio

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

GET /orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
`ORG-ID`	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.
`CLIENT-ID`	string	El identificador único de la cuenta de servicio que desea recuperar. Solicite el punto de conexión /orgs/{ORG-ID}/serviceAccounts para recuperar todas las cuentas de servicio de la organización especificada 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).

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

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

Respuesta

Elementos de respuesta

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

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

Nombre	Tipo	Descripción
`clientId`	string	Identificador único para la cuenta de servicio.
`description`	string	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 `-`.
`name`	string	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 `-`.
`createdAt`	fecha y hora	Hora de creación de la cuenta de servicio.
`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.secret`	string	Secreto de cuenta de servicio, disponible solo en el momento de su creación.
`secrets.maskedSecretValue`	string	Secreto enmascarado que solo muestra el prefijo y los últimos cuatro caracteres.
`secrets.createdAt`	fecha y hora	Marca de tiempo que representa la hora de creación del secreto.
`secrets.lastUsedAt`	fecha y hora	Marca de tiempo que representa el último uso del secreto.
`secrets.expiresAt`	fecha y hora	Marca de tiempo que representa el tiempo de expiración del secreto.
`roles`	matriz de objetos	Roles que tiene la cuenta de servicio en la organización. Los roles de la organización incluyen: `ORG_OWNER` `ORG_MEMBER` `ORG_GROUP_CREATOR` `ORG_BILLING_ADMIN` `ORG_READ_ONLY` `ORG_BILLING_READ_ONLY`

Ejemplo de solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/serviceAccounts/{CLIENT-ID}?pretty=true"

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

{
 "createdAt" : "2024-05-31T17:27:05Z",
 "description" : "This service account is for admins.",
 "clientId" : "mdb_sa_id_665a086958c92d31a28d452e",
 "name" : "Admin Service Account",
 "roles" : [ "ORG_OWNER" ],
 "secrets" : [ {
   "createdAt" : "2024-05-31T17:27:05Z",
   "expiresAt" : "2025-05-31T17:27:05Z",
   "id" : "665a086958c92d31a28d452f",
   "maskedSecretValue" : "mdb_sa_sk_…OEyV"
  } ]
}

Volver

Obtener todo

Obtener todas las asignaciones