Docs Home

/ /

Autenticación federada

Docs Home

/ /

Recursos

Autenticación federada

Autenticación federada

Registrar un mapeo de rol

El recurso federationSettings permite devolver una asignación de roles de la organización especificada en la federación indicada.

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

Roles necesarios

Debe tener el rol Organization Owner para llamar a este endpoint.

Resource

GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings/{ROLE-MAPPING-ID}

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
`FEDERATION-SETTINGS-ID`	string	string única de 24 dígitos hexadecimales que identifica la configuración de autenticación federada.
`ORG-ID`	string	string única de 24 dígitos hexadecimales que identifica a la organización conectada.
`ROLE-MAPPING-ID`	string	string única de 24 dígitos hexadecimales que identifica la asignación de roles.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que muestra si el cuerpo de la respuesta debe estar en formato prettyprint.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

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

Respuesta

Nombre	Tipo	Descripción
`externalGroupName`	string	Etiqueta única, legible por humanos, que identifica al grupo de proveedor de identidad asociado con la asignación de roles.
`id`	string	string única de 24 dígitos hexadecimales que identifica la asignación de roles.
`roleAssignments`	arreglo	Lista que contiene los identificadores únicos de los proyectos y organizaciones asociados a cada rol.
`roleAssignments.groupId`	string	string única de 24 dígitos hexadecimales que identifica el Proyecto al que se aplica el rol.
`roleAssignments.orgId`	string	string única de 24 dígitos hexadecimales que identifica la organización en la que aplica el rol.
`roleAssignments.role`	string	Etiqueta legible por humanos que identifica el rol.

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings/{ROLE-MAPPING-ID}"

Respuesta de ejemplo

{
 "externalGroupName": "autocomplete-highlight",
 "id": "61d88e15e6cc044270a36fce",
 "roleAssignments": [
     {
         "groupId": null,
         "orgId": "5f86fb11e0079069c9ec3132",
         "role": "ORG_OWNER"
     },
     {
         "groupId": "5f86fb2ff9c4e56d39502559",
         "orgId": null,
         "role": "GROUP_OWNER"
     }
 ]
}

Volver

Devolver todos los mapeos de roles

Devolver todos los proveedores de identidad