Devolver una cuenta de servicio de la organización

Obtener /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}

Cuentas de servicio Autorización de resumen

Devuelve la cuenta de servicio especificada.

Parámetros de ruta

orgId string Requerido

Cadena 24hexadecimal única que identifica la organización que contiene sus proyectos. Utilice el /orgs punto de conexión para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso.

El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
ID de cliente string Requerido

El ID de cliente de la cuenta de servicio.

El formato debe coincidir con el siguiente patrón: ^mdb_sa_id_[a-fA-F\d]{24}$.

Parámetros de consulta

envolvente booleano

Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

El valor predeterminado es false.
bonita booleano

Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.

El valor predeterminado es false.

Impresión bonita

Respuestas

200 application/vnd.atlas.2024-08-05+json

Vale
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- ID de cliente string
  
  El ID de cliente de la cuenta de servicio.
  
  El formato debe coincidir con el siguiente patrón: ^mdb_sa_id_[a-fA-F\d]{24}$.
- creadoEn cadena(fecha-hora)
  
  Fecha de creación de la cuenta de servicio. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.
- Descripción string
  
  Descripción legible para humanos de la cuenta de servicio.
- Nombre string
  
  Nombre legible para humanos para la cuenta de servicio.
- papeles array[string]
  
  Una lista de roles de la organización asociados con la cuenta de servicio.
  
  Los valores son ORG_MEMBER, ORG_READ_ONLY, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_STREAM_PROCESSING_ADMIN, ORG_GROUP_CREATOR o ORG_OWNER.
- secretos matriz[objeto]
  
  Lista de secretos asociados con la cuenta de servicio especificada.
  
  Ocultar atributos secretos Mostrar atributos secretos Objeto
  
  creadoEn cadena(fecha-hora) Requerido
  
  Fecha de creación del secreto. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.
  
  expira en cadena(fecha-hora) Requerido
  
  Fecha de vencimiento del secreto. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.
  
  ID. string Requerido
  
  Cadena de dígitos hexadecimales 24única que identifica el secreto.
  
  El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
  
  lastUsedAt cadena(fecha-hora)
  
  La última vez que se usó el secreto. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.
  
  maskedSecretValue string
  
  El secreto de la cuenta de servicio enmascarado.
  
  secreto string
  
  El secreto de la cuenta de servicio. Se devolverá solo la primera vez tras su creación.
401 aplicación/json

No autorizado.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.
403 aplicación/json

Forbidden.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.
404 aplicación/json

No se encontró.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.
500 aplicación/json

Error Interno del Servidor.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.

OBTENER /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}

atlas api serviceAccounts getOrgServiceAccount --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetOrgServiceAccountApiParams{}
	sdkResp, httpResp, err := client.ServiceAccountsApi.
		GetOrgServiceAccountWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}?pretty=true"

Ejemplos de respuestas (200)

{
  "clientId": "mdb_sa_id_1234567890abcdef12345678",
  "createdAt": "2026-05-04T09:42:00Z",
  "description": "string",
  "name": "string",
  "roles": [
    "ORG_MEMBER"
  ],
  "secrets": [
    {
      "createdAt": "2026-05-04T09:42:00Z",
      "expiresAt": "2026-05-04T09:42:00Z",
      "id": "32b6e34b3d91647abb20e7b8",
      "lastUsedAt": "2026-05-04T09:42:00Z",
      "maskedSecretValue": "mdb_sa_sk_...",
      "secret": "mdb_sa_sk_..."
    }
  ]
}

Ejemplos de respuestas (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Ejemplos de respuestas (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Ejemplos de respuestas (404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

Ejemplos de respuestas (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}