El federationSettings El recurso le permite devolver todos
asignaciones de roles de la organización especificada en la federación especificada.
Roles necesarios
Debe tener el rol para llamar a este punto Organization Owner final.
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings
Solicitud
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Cadena de dígitos hexadecimales 24única que identifica la configuración de autenticación federada. |
| string | Cadena de dígitos hexadecimales 24única que identifica la organización conectada. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
| ||||||
envolvente | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
links
Una matriz de documentos que representa un enlace a uno o más subrecursos o recursos relacionados, como la paginación de listas. Consulte Enlaces para obtener más información.
results
Una serie de documentos, cada uno de los cuales representa una asignación de roles.
Nombre | Tipo | Descripción |
|---|---|---|
| string | Etiqueta única legible por humanos que identifica al grupo de proveedores de identidad asociado con la asignación de roles. |
| string | Cadena de dígitos hexadecimales 24única que identifica la asignación de roles. |
| arreglo | Lista que contiene los identificadores únicos de los proyectos y organizaciones asociados con cada rol. |
| string | Cadena de dígitos hexadecimales 24única que identifica el proyecto en el que se aplica el rol. |
| string | Cadena de dígitos hexadecimales 24única que identifica la organización en la que se aplica el rol. |
| string | Etiqueta legible por humanos que identifica el rol. |
totalCount
Número total de elementos en el conjunto de resultados. Este valor puede ser mayor que el número de objetos en la matriz 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 }