Exemplo: API de REST do Credentials para autenticação baseada em OAuth 2.0

Este exemplo mostra como usar a API REST do Credentials de operações em nuvem para gerenciar credenciais de cliente para autenticação baseada em OAuth 2.0 de aplicativos cliente.

Antes de iniciar
  • Autorização: o responsável pela chamada da API deve ter a função de Administrador da conta.
  • Todas as chamadas de API exigem um token de solicitação de falsificação entre sites (CSRF) válido no cabeçalho IBM® -CSRF-TOKEN da chamada. Obtenha um token de CSRF usando POST /instance/services/csrf_token. Para obter mais informações, consulte Evitando falsificação de solicitação de cross site.
Recupere uma lista de credenciais do cliente OAuth 2.0
Use a chamada a seguir para exibir uma lista de credenciais do cliente para a assinatura:
GET /instance/services/credentials/oauth_clients
Uma lista de credenciais do cliente é retornada. Cada entrada inclui o ID do cliente, o criador das credenciais, o horário da criação e a descrição. Para incluir a paginação na chamada, use os parâmetros de deslocamento e tamanho:
GET /instance/services/credentials/oauth_clients?offset=11&size=10
Crie um conjunto de credenciais do cliente OAuth 2.0
As credenciais de cliente consistem em um ID do cliente e um segredo do cliente. O ID do cliente é gerado por meio de um prefixo que você especifica no objeto JSON no corpo da chamada. É uma boa prática especificar uma descrição também para que seja possível identificar com facilidade posteriormente para o que as credenciais são usadas.
Por exemplo, se desejar criar credenciais para um aplicativo de empréstimos, use a chamada a seguir:
POST /instance/services/credentials/oauth_clients
...
{
  "id_prefix": "loanapp"
  "description": "OAuth credentials for loan application."  
}
O objeto retornado inclui o ID do cliente gerado e o segredo do cliente. Use essas credenciais juntas com credenciais de serviço para controle de acesso baseado em OAuth ao ambiente de nuvem para seu aplicativo de empréstimo. Para obter mais informações, consulte Uso da autenticação baseada em OAuth 2.0 para aplicativos clientes.
Excluir um conjunto de credenciais do cliente do OAuth 2.0
Use a chamada a seguir para excluir as credenciais do cliente:
DELETE /instance/services/credentials/{client_id}
O ID do cliente e o segredo do cliente são excluídos. Se os aplicativos clientes ainda estiverem usando as credenciais para autenticação baseada em OAuth 2.0, eles não poderão obter novos tokens de atualização. O código de resposta HTTP BAD_REQUEST (400) será retornado em vez disso. Para obter mais informações, consulte a etapa de atualização em Usando a autenticação baseada em OAuth 2.0 para aplicativos clientes.