La federationSettings el recurso te permite devolver todos los
mapeo de roles de la organización especificada en la federación especificada.
Roles necesarios
Debe tener el rol Organization Owner para llamar a este endpoint.
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings
Solicitud
Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | string única de 24 dígitos hexadecimales que identifica la configuración de autenticación federada. |
| string | string única de 24 dígitos hexadecimales que identifica a la organización conectada. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de respuesta debe estar en un prettyprint formato. |
| ||||||
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar este problema, configure envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
links
Un arreglo de documentos que representa un enlace a uno o más subrecursos y/o recursos relacionados, como la paginación de la lista. Consulta Vinculación para obtener más información.
results
Un arreglo de documentos, cada uno representando una asignación de roles.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Etiqueta única, legible por humanos, que identifica al grupo de proveedor de identidad asociado con la asignación de roles. |
| string | string única de 24 dígitos hexadecimales que identifica la asignación de roles. |
| arreglo | Lista que contiene los identificadores únicos de los proyectos y organizaciones asociados a cada rol. |
| string | string única de 24 dígitos hexadecimales que identifica el Proyecto al que se aplica el rol. |
| string | string única de 24 dígitos hexadecimales que identifica la organización en la que aplica el rol. |
| string | Etiqueta legible por humanos que identifica el rol. |
totalCount
El número total de elementos en el conjunto de resultados. Este valor puede ser superior al número de objetos en el arreglo results si todo el conjunto de resultados está paginado.
Ejemplo
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/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings"
Respuesta
{ "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "externalGroupName": "autocomplete-highlight", "id": "61d88e15e6cc044270a36fce", "roleAssignments": [ { "groupId": null, "orgId": "{ORG-ID}", "role": "ORG_OWNER" }, { "groupId": "{GROUP-ID}", "orgId": null, "role": "GROUP_OWNER" } ] } ], "totalCount": 1 }