Obter todas as contas de serviço da organização atribuídas a um projeto
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 .
URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/serviceAccounts
Parâmetros do caminho da solicitação
Nome | Tipo | Descrição |
---|---|---|
| string | Identificador exclusivo do projeto do qual você deseja recuperar as contas de serviço da organização atribuídas. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso. |
Solicitar parâmetros de query
Os seguintes parâmetros de query são opcionais:
Nome | Tipo | Descrição | Default | ||||||
---|---|---|---|---|---|---|---|---|---|
pageNum | inteiro | Número da página (com base em índice 1). |
| ||||||
itemsPerPage | inteiro | Número de itens a serem devolvidos por página, até um máximo de 500. |
| ||||||
pretty | booleano | Indica se o corpo da resposta deve estar em um prettyprint formato. |
| ||||||
envelope | booleano | Indica se deseja ou não envolver a resposta em um envelope. Alguns clientes do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure Para endpoints que retornam um resultado, o corpo da resposta inclui:
Para endpoints que retornam uma lista de resultados, o objeto | none |
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
documento de resposta
O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.
Nome | Tipo | Descrição |
---|---|---|
| array | A array inclui um objeto para cada item detalhado na seção |
| array | A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web. |
| número | Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado. |
results
documento incorporado
Cada resultado é uma conta de serviço do Projeto.
Nome | Tipo | Descrição |
---|---|---|
| string | Identificador exclusivo da conta de serviço. |
| timestamp | Hora de criação da conta de serviço. |
| string | Nome da conta de serviço. |
| string | Descrição da conta de serviço. |
| array de strings | Lista de roles que a conta de serviço tem no projeto. As funções do projeto incluem: |
| array de objetos | Lista de segredos de conta de serviço. |
| string | 24-string exclusivo de caracteres hexadecimais que identifica o segredo. |
| timestamp | Timestamp representando o tempo de criação do segredo. |
| timestamp | Timestamp representando o tempo de expiração secreto. |
| timestamp | Registro de data/hora representando o último uso secreto. |
| string | Segredo oculto que exibe apenas o prefixo e os últimos quatro caracteres. |
Exemplo de solicitação
Observação
O usuário que faz a solicitação pode ser formatado como {PUBLIC-KEY}:{PRIVATE-KEY}
.
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/serviceAccounts?pretty=true"
Exemplo de resposta
Cabeçalho de resposta
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
Corpo de resposta
1 { 2 "links": [ 3 { 4 "href": "https://cloud.mongodb.com/api/public/v1.0/groups/66ae30345fe4416479e39269/serviceAccounts?pretty=true&pageNum=1&itemsPerPage=100", 5 "rel": "self" 6 } 7 ], 8 "results": [ 9 { 10 "createdAt": "2024-08-03T14:02:40Z", 11 "description": "Service account for Cloud Manager users.", 12 "clientId": "mdb_sa_id_66ae38803cdf55582cb01144", 13 "name": "General Access", 14 "roles": ["GROUP_DATA_ACCESS_ADMIN", "GROUP_READ_ONLY"], 15 "secrets": [ 16 { 17 "createdAt": "2024-08-03T14:02:40Z", 18 "expiresAt": "2024-12-31T14:02:40Z", 19 "lastUsedAt" : "2024-08-24T21:10:35Z", 20 "id": "66ae38803cdf55582cb01143", 21 "maskedSecretValue": "mdb_sa_sk_...hcOL" 22 } 23 ] 24 }, 25 { 26 "createdAt": "2024-08-03T14:05:20Z", 27 "description": "Service account for read access.", 28 "clientId": "mdb_sa_id_66ae38803cdf55582cb01145", 29 "name": "Read Only Access", 30 "roles": ["GROUP_READ_ONLY"], 31 "secrets": [ 32 { 33 "createdAt": "2024-08-03T14:05:20Z", 34 "expiresAt": "2024-12-31T14:05:20Z", 35 "lastUsedAt" : "2024-08-24T21:10:35Z", 36 "id": "66ae38803cdf55582cb01146", 37 "maskedSecretValue": "mdb_sa_sk_...jcOP" 38 } 39 ] 40 }, 41 { 42 "createdAt": "2024-08-03T14:10:00Z", 43 "description": "Service account for data backup.", 44 "clientId": "mdb_sa_id_66ae38803cdf55582cb01147", 45 "name": "Backup Access", 46 "roles": ["GROUP_DATA_BACKUP_ADMIN"], 47 "secrets": [ 48 { 49 "createdAt": "2024-08-03T14:10:00Z", 50 "expiresAt": "2024-12-31T14:10:00Z", 51 "lastUsedAt" : "2024-08-24T21:10:35Z", 52 "id": "66ae38803cdf55582cb01148", 53 "maskedSecretValue": "mdb_sa_sk_...kcQR" 54 } 55 ] 56 } 57 ], 58 "totalCount": 3 59 }