Retornar todos os mapeamentos de role
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
O recurso federationSettings permite a você retornar todos os mapeamentos de role da organização especificada na federação especificada.
Funções obrigatórias
Você deve ter o role Organization Owner para chamar esse endpoint.
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/{ORG-ID}/roleMappings
Solicitar
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
|---|---|---|
| string | String exclusiva de 24 dígitos hexadecimais que identifica a configuração da autenticação federada. |
| string | String exclusiva de 24 dígitos hexadecimais que identifica a organização conectada. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | necessidade | Descrição | Default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador indicando se o corpo da resposta deve estar em um prettyprint formato. |
| ||||||
envelope | booleano | Opcional | Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes da 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:
|
|
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
links
Uma array de documentos, representando um link para um ou mais sub-recursos e/ou recursos relacionados, como paginação de lista. Consulte Vinculação para obter mais informações.
results
Uma array de documentos, cada um representando um mapeamento de role.
Nome | Tipo | Descrição |
|---|---|---|
| string | Rótulo legível único para humanos que identifica o grupo de fornecedores de identidade associado ao mapeamento de role. |
| string | String exclusiva de 24 dígitos hexadecimais que identifica o mapeamento de função. |
| array | Lista que contém os identificadores exclusivos para os projetos e organizações associados a cada role. |
| string | String única de 24 dígitos hexadecimais que identifica o projeto ao qual a role se aplica. |
| string | String única de 24 dígitos hexadecimais que identifica a organização à qual a role se aplica. |
| string | Etiqueta legível para humanos que identifica a role. |
totalCount
O número total de itens no conjunto de resultados. Esse valor pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.
Exemplo
Solicitar
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"
Resposta
{ "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 }