Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Retornar um mapeamento de role

O recurso federationSettings permite a você retornar um mapeamento de role da organização especificada na federação especificada.

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

Você deve ter o role Organization Owner para chamar esse endpoint.

GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings/{ROLE-MAPPING-ID}
Nome
Tipo
Descrição

FEDERATION-SETTINGS-ID

string

String exclusiva de 24 dígitos hexadecimais que identifica a configuração da autenticação federada.

ORG-ID

string

String exclusiva de 24 dígitos hexadecimais que identifica a organização conectada.

ROLE-MAPPING-ID

string

String exclusiva de 24 dígitos hexadecimais que identifica o mapeamento de função.

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default

pretty

booleano

Opcional

Sinalizador que indica se o corpo da resposta deve estar em um formato prettyprint.

false

envelope

booleano

Opcional

Sinalizador que indica se deve envolver a resposta em um envelope.

Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

  • status: Código de resposta HTTP

  • content: Corpo de resposta esperado

false

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Nome
Tipo
Descrição

externalGroupName

string

Rótulo legível único para humanos que identifica o grupo de fornecedores de identidade associado ao mapeamento de role.

id

string

String exclusiva de 24 dígitos hexadecimais que identifica o mapeamento de função.

roleAssignments

array

Lista que contém os identificadores exclusivos para os projetos e organizações associados a cada role.

roleAssignments.groupId

string

String única de 24 dígitos hexadecimais que identifica o projeto ao qual a role se aplica.

roleAssignments.orgId

string

String única de 24 dígitos hexadecimais que identifica a organização à qual a role se aplica.

roleAssignments.role

string

Etiqueta legível para humanos que identifica a role.

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}"
{ "externalGroupName": "autocomplete-highlight", "id": "61d88e15e6cc044270a36fce", "roleAssignments": [ { "groupId": null, "orgId": "5f86fb11e0079069c9ec3132", "role": "ORG_OWNER" }, { "groupId": "5f86fb2ff9c4e56d39502559", "orgId": null, "role": "GROUP_OWNER" } ]}