Autorização de aplicações
Função
Uma aplicação não pode acessar nenhuma API imediatamente após sua criação. Para acessar uma API em um ambiente, primeiro autorize a aplicação a chamar a API.
URI
A tabela a seguir lista o método de solicitação HTTP/HTTPS e o URI da API.
Método de solicitação |
URI |
---|---|
POST |
/v1.0/apigw/app-auths |
Solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
api_ids |
Sim |
Array of strings |
Lista de IDs da API |
app_ids |
Sim |
Array of strings |
Lista de IDs de aplicações |
env_id |
Sim |
String |
ID do ambiente no qual as aplicações serão autorizadas |
Exemplo de solicitação:
{ "api_ids": ["5bbc47e2-95b0-4a56-904e-a3cdc422f8e9", "6632a062-9dcf-4f18-9646-3cabb925a290"], "app_ids": ["14b399ac-967f-4115-bb62-c0346b4537e9"], "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID" }
Resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
-- |
Dicionário |
Lista de autorizações |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID de autorização |
api_id |
String |
ID da API |
app_id |
String |
ID de aplicação |
auth_time |
Timestamp |
Tempo de autorização |
auth_role |
String |
Autorizador, que pode ser: PROVIDER CONSUMER |
auth_result |
String |
Resultado da autorização, que pode ser: SUCCESS SKIPPED |
Exemplo de resposta:
[{ "id": "dffcaff92d144135a9f420fcd485bbf3", "api_id": "8aa097b00e9843efabc9c593d11b769d", "app_id": "f8c6ea15-0d1b-4c5b-bd4b-911610bd3b3e", "auth_time": "2018-03-30T09:37:43.490197204Z", "auth_role": "PROVIDER", "auth_result": "SUCCESS" }]
Códigos de status
Código de status |
Descrição |
---|---|
201 |
Criado |
400 |
Solicitação inválida |
401 |
Não autorizado |
403 |
Proibido |
404 |
Não encontrado |
409 |
Conflito |
500 |
Erro do servidor interno |