Devolver una configuración de organización de una federación

OBTENER /api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}

Devuelve la configuración de la organización conectada especificada desde la federación especificada. Para usar este recurso, la cuenta de servicio o clave de API solicitante debe tener el rol de propietario de la organización en la organización conectada.

Parámetros de path

  • federationSettingsId string Requerido

    string única de 24 dígitos hexadecimales que identifica a tu federación.

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

  • orgId string Requerido

    string única de 24 dígitos hexadecimales que identifica la configuración de la organización conectada a devolver.

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

Parámetros de query

  • envelope booleano

    Bandera que indica si la aplicación envuelve 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 remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • dataAccessIdentityProviderIds array[string]

      La colección de ID únicos que representan a los proveedores de identidad que pueden utilizarse para acceder a los datos de esta organización.

    • domainAllowList array[string]

      Dominios aprobados que restringen a los usuarios que pueden unirse a la organización en función de sus direcciones de correo electrónico.

    • Restricción de dominio habilitada booleano Requerido

      Valor que indica si la restricción de dominio está habilitada para esta organización conectada.

    • ID del proveedor de identidad string

      Cadena heredada de 20dígitos hexadecimales que identifica al proveedor de identidad de acceso de Interfaz de Usuario con el que se asocia esta configuración de organización conectada. Este id se puede encontrar dentro de la Consola de Gestión de Federaciones > pestaña Proveedores de Identidad haciendo clic en el icono de información en la fila IdP ID de un proveedor de identidad configurado.

      El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{20})$.

    • orgId string Requerido

      string única de dígitos hexadecimales de 24que identifica la configuración de la organización conectada.

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

    • Concesiones de rol de autorización posterior array[string]

      Roles de Atlas que se otorgan a un usuario de esta organización después de la autenticación. Los roles son etiquetas legibles por humanos que identifican la colección de privilegios que MongoDB Nube otorga a un usuario específico de MongoDB Nube. Estos roles solo pueden ser roles específicos de la organización.

      Los valores son ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN, ORG_BILLING_READ_ONLY, ORG_STREAM_PROCESSING_ADMIN o ORG_READ_ONLY.

    • roleMappings arreglo[objeto]

      Mapeos de roles que están configurados en esta organización.

      Ocultar atributos de roleMappings Mostrar los atributos de roleMappings Objeto

      Configuraciones de asignación que vinculan un proveedor de identidad y MongoDB nube.

      • externalGroupName string Requerido

        Etiqueta única legible por humanos que identifica el grupo de proveedor de identidad al que se aplica este mapeo de roles.

        La longitud mínima es de 1, la longitud máxima es de 200.

      • ID string

        Cadena única 24-hexadecimal que identifica esta asignación de roles.

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

      • assignment de roles arreglo[objeto] Requerido

        Roles de Atlas y los identificadores únicos de los grupos y organizaciones asociados a cada rol. El arreglo debe incluir al menos un elemento con un rol de organización y su respectivo orgId. Cada elemento del arreglo puede tener un valor para orgId o groupId, pero no ambos.

        Ocultar atributos de roleAssignments Mostrar los atributos de roleAssignments Objeto
        • ID del grupo string

          Cadena única de dígitos hexadecimales 24que identifica el proyecto al que pertenece este rol. Cada elemento dentro de roleAssignments puede tener un valor para groupId o orgId, pero no para ambos.

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

        • orgId string

          string única de dígitos hexadecimales 24que identifica la organización a la que pertenece este rol. Cada elemento dentro de roleAssignments puede tener un valor para orgId o groupId, pero no ambos.

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

        • rol string

          Etiqueta legible por humanos que identifica la colección de privilegios que MongoDB Cloud otorga a una clave API específica, a un usuario de MongoDB Cloud o a un equipo de MongoDB Cloud. Estos roles incluyen roles a nivel de organización y de proyecto.

          Roles de usuario de MongoDB Atlas
    • conflictosUsuario arreglo[objeto]

      Lista que contiene los usuarios que tienen una dirección de correo electrónico que no coincide con ningún dominio en la lista permitida.

      Ocultar atributos de userConflicts Mostrar atributos userConflicts Objeto

      Usuario de MongoDB nube vinculado a esta autenticación federada.

      • dirección de correo electrónico cadena(correo electrónico) Requerido

        Dirección de correo electrónico del usuario de MongoDB Cloud vinculado a la organización federada.

      • federationSettingsId string Requerido

        string única de 24dígitos hexadecimales que identifica la federación a la que pertenece este usuario de MongoDB Cloud.

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

      • firstName string Requerido

        Nombre o nombre de pila que pertenece al usuario de MongoDB Cloud.

      • lastName string Requerido

        Apellido familiar, nombre de familia o apellido que pertenece al usuario de MongoDB Cloud.

      • ID de usuario string

        Cadena única de 24 dígitos hexadecimales que identifica a este usuario.

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

  • 400 aplicación/json

    Solicitud incorrecta.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

GET /api/atlas/v1.0/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/federationSettings/55fa922fb343282757d9554e/connectedOrgConfigs/32b6e34b3d91647abb20e7b8' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuestas (200)
{
  "dataAccessIdentityProviderIds": [
    "string"
  ],
  "domainAllowList": [
    "string"
  ],
  "domainRestrictionEnabled": true,
  "identityProviderId": "string",
  "orgId": "32b6e34b3d91647abb20e7b8",
  "postAuthRoleGrants": [
    "ORG_OWNER"
  ],
  "roleMappings": [
    {
      "externalGroupName": "string",
      "id": "32b6e34b3d91647abb20e7b8",
      "roleAssignments": [
        {
          "groupId": "32b6e34b3d91647abb20e7b8",
          "orgId": "32b6e34b3d91647abb20e7b8",
          "role": "string"
        }
      ]
    }
  ],
  "userConflicts": [
    {
      "emailAddress": "hello@example.com",
      "federationSettingsId": "32b6e34b3d91647abb20e7b8",
      "firstName": "string",
      "lastName": "string",
      "userId": "32b6e34b3d91647abb20e7b8"
    }
  ]
}
Ejemplos de respuestas (400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
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"
}