Docs Home

/ /

Cuentas de la Organización

Docs Home

/ /

Cuentas de servicio

Cuentas de la Organización

Cuentas de la Organización

Obtener una cuenta de servicio

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

Resource

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

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
`ORG-ID`	string	El identificador único de la organización cuya cuenta de servicio deseas recuperar. Use el endpoint /orgs para recuperar todas las organizaciones a las que el usuario autenticado tenga acceso.
`CLIENT-ID`	string	El identificador único de la cuenta de servicio que deseas recuperar. Solicite el endpoint /orgs/{ORG-ID}/serviceAccounts para recuperar todas las cuentas de servicio de la organización especificada a la 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).

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 formato prettyprint.

false

envelope

booleano

Indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP o al código de estado. Para remediarlo, establezca "envelope" : true en la query.

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

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Elementos de respuesta

Si configuras el elemento de query envelope en true, la respuesta estará envuelta en 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.
`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`	Marca de tiempo	Hora de creación de la cuenta de servicio.
`secrets`	objeto arreglo	Lista de secretos de cuentas de servicio.
`secrets.id`	string	string única de 24caracteres hexadecimales que identifica el secreto.
`secrets.secret`	string	Secreto de cuenta de servicio, disponible solo durante la creación.
`secrets.maskedSecretValue`	string	Secreto enmascarado que solo muestra el prefijo y los últimos cuatro caracteres.
`secrets.createdAt`	Marca de tiempo	Timestamp que representa la hora de creación del secreto.
`secrets.lastUsedAt`	Marca de tiempo	Marca de tiempo que representa el último uso del secreto.
`secrets.expiresAt`	Marca de tiempo	Marca de tiempo que representa la fecha de caducidad del secreto.
`roles`	objeto arreglo	Roles que la cuenta de servicio tiene 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`

Solicitud de ejemplo

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"

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

{
 "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