Documentação do Oracle Cloud Infrastructure

Conceitos Básicos da API REST de Domínios de Identidades

A API REST dos domínios de identidades gerencia recursos com segurança, incluindo identidades e dados de configuração. O suporte para o OpenID Connect permite a integração com aplicativos compatíveis e domínios de identidade. O serviço OAuth2 fornece uma infraestrutura de API para autorização que suporta uma faixa de tipos de concessão de token que permitem conectar com segurança clientes a serviços.

A API REST de domínios de identidades suporta pontos finais compatíveis com SCIM 2.0 com esquemas principais SCIM 2.0 padrão e extensões de esquema Oracle para:

  • Gerencie usuários, grupos e aplicativos.

  • Execute funções de identidade, incluindo geração e redefinição de senha.

  • Execute tarefas administrativas, incluindo operações em massa e programação de jobs.

  • Configure definições para um domínio de identidades, incluindo autenticação multifator, marca e modelos de notificação.

Este guia contém as seguintes seções:

  • Avisos de Obsolescência de Pontos Finais: Saiba mais sobre os avisos de descontinuação de pontos finais para domínios de identidades.
  • Início Rápido: Comece rapidamente a usar a API REST de domínios de identidades concluindo pré-requisitos, instalando curl e configurando a autorização para gerenciar seus recursos de domínio de identidades, como usuários, grupos e aplicativos.
  • Limites de Taxa de API: Entenda a limitação de taxa para APIs para diferentes tipos de domínio de identidades.
  • Estruturando Solicitações de Recursos: Aprenda as diretrizes para criar solicitações de envio em um domínio de identidades.
  • Usando cURL: Saiba como usar o cURL para acessar as APIs REST.
  • Gerenciando Autorização Usando a API: Saiba como usar um cliente OAuth para acessar a API REST de domínios de identidades. A API REST de domínios de identidades não pode ser acessada usando apenas um nome de usuário e uma senha de domínio de identidades. Para acessar a API REST de domínios de identidades, você precisa de um token de acesso OAuth2 ou de uma chave de API a ser usada para autorização.
  • Casos de Uso de API: Percorra os casos de uso típicos usando as APIs REST do domínio de identidades.

Os recursos a seguir não estão neste guia, mas também estão disponíveis para você.

Ao usar a interface de usuário dos domínios de identidades:

Ao usar a API ou a CLI:

  • Para gerenciar domínios de identidade (por exemplo, criar ou excluir um domínio), consulte API do Serviço IAM.
  • Para gerenciar recursos em um domínio de identidades, por exemplo, usuários, grupos de recursos dinâmicos, grupos e provedores de identidades, consulte CLI de Domínios de Identidade.

Avisos de Obsolescência de Pontos Finais

Leia os avisos de descontinuação do ponto final para domínios de identidades no serviço IAM.

Para revisar detalhes sobre as mudanças revolucionárias do Oracle Cloud Infrastructure, como recursos obsoletos, APIs obsoletas e alterações no comportamento dos serviços, consulte Anúncios de Alteração do Serviço IAM.

Início Rápido

Comece rapidamente a usar a API REST de domínios de identidades concluindo pré-requisitos, instalando curl e configurando a autorização para gerenciar seus recursos de domínio de identidades, como usuários, grupos e aplicativos.

Pré-requisitos

  1. Compre uma Assinatura do Oracle Cloud: Consulte Comprar uma Assinatura do Oracle Cloud.
  2. Ativar sua ordem: Configure sua conta ou ative sua ordem. Consulte Ativar seu Pedido do E-mail de Boas-vindas em Comprar uma Assinatura do Oracle Cloud.
  3. Obtenha as credenciais de conta e a autorização apropriadas para acessar APIs de domínio de identidades do administrador do domínio de identidades:

    • Para acessar seu domínio de identidades. Consulte o administrador do domínio de identidades para obter seu nome de usuário, senha e nome do domínio de identidades.

    • Para usar a API sem uma conta de usuário. Os administradores podem usar a API de domínios de identidades sem uma conta de usuário no domínio de identidades. Para usar a API de domínios de identidades sem uma conta de usuário, solicite ao administrador do domínio de identidades um ID de cliente e um segredo de cliente.

Etapa 1: Acessar o Domínio de Identidades

Depois de ativar sua conta, você receberá credenciais de acesso e um link para a home page do seu domínio de identidades. Selecione o link no e-mail e informe as credenciais de acesso fornecidas. A home page do seu domínio de identidades é exibida. Consulte Acessar a Console.

Etapa 2: Instalar cURL

Os exemplos neste documento usam a ferramenta de linha de comando cURL para demonstrar como acessar a API REST de domínios de identidades.

Para se conectar com segurança ao servidor, instale uma versão do cURL compatível com SSL e forneça um arquivo ou um pacote de certificados de autoridade de certificação SSL (CA) para autenticação em relação ao certificado de CA Verisign. Para obter mais informações sobre:

O procedimento a seguir demonstra como instalar o cURL em um sistema Windows de 64 bits.

  1. Em um navegador, acesse a home page do cURL em http://curl.haxx.se/download.html.

  2. Na página Releases and Downloads do cURL, localize a versão habilitada para SSL correspondente ao seu SO e, em seguida, selecione o link para fazer o download do arquivo ZIP.

  3. Instale o software.

  4. Navegue até a página Certificados de CA cURL em http://curl.haxx.se/docs/caextract.html e faça download do pacote de certificados de autoridade de certificação SSL (CA) CA-bundle.crt na pasta em que você instalou o cURL.

  5. Defina a variável do ambiente cURL:

    1. Abra uma janela de comandos.

    2. Navegue até o diretório em que você instalou o cURL.

    3. Defina a variável de ambiente cURL (CURL_CA_BUNDLE) para o local do pacote de certificados SSLCA. Por exemplo: C:\curl> set CURL_CA_BUNDLE=ca-bundle.crt.

Etapa 3: Compreender o Formato do URL do Recurso

Você acessa a API REST de domínios de identidades usando um URL, que inclui o ponto final REST, o recurso que você deseja acessar e quaisquer parâmetros de consulta que você deseja incluir em uma solicitação.

O ponto final básico da API REST de domínios de identidades é:

https://<domainURL>/admin/v1/

Consulte Enviar Solicitações para obter detalhes específicos sobre como criar esses URLs.

Etapa 4: Configurar Autorização

Você precisa gerar o token de acesso que pode ser usado para autorizar solicitações enviadas à API REST de domínios de identidades. Consulte Gerenciando Autorização Usando a API.

Agora você está pronto para enviar solicitações a um domínio de identidades usando cURL.

Etapa 5: Gerenciar seus Recursos do Domínio de Identidades

Comece a usar a API REST para gerenciar configurações e identidades e recursos gerais do domínio de identidades.

Limites de Taxa de API

Entenda a limitação de taxa para APIs para diferentes tipos de domínio de identidades.

As APIs Oracle estão sujeitas à limitação de taxa para proteger o uso de serviços de API para todos os clientes da Oracle. Se você atingir o limite de API para o tipo de domínio de identidades, o serviço IAM retornará um código de erro 429.

Limites de Taxa para todos os Tipos de Domínio de Identidades

Grupo de APIs Por Gratuito Aplicativos Oracle Aplicativos Oracle Premium Premium Usuário Externo
AuthN segundo 10 50 80 95 90
AuthN minuto 150 1000 2100 4500 3100
BasicAuthN segundo 10 100 160 95 90
BasicAuthN minuto 150 3.000 4000 4500 3100
Gerenciamento de token segundo 10 40 50 65 60
Gerenciamento de token minuto 150 1000 1700 3400 2300
Outros segundo 20 50 55 90 80
Outros minuto 150 1500 1750 5000 4000
Importação em Massa segundo 5 5 5 5 5
Importação em Massa minuto 200 200 200 200 200
Importar e exportar dia 4 8 10 10 10
Observação

O número máximo de objetos de Confiança de Propagação de Identidade que podem ser criados é restrito a 30. Entre em contato com o suporte se o limite precisar ser aumentado. Para obter mais informações sobre limites de objeto, consulte Limites de Objeto do Domínio de Identidades do Serviço IAM.

APIs em Grupos de APIs

Os limites de API se aplicam ao total de todas as APIs em um grupo.

Autenticação
  • /sso/v1/user/login
  • /sso/v1/user/secure/login
  • /sso/v1/user/logout
  • /sso/v1/sdk/authenticate
  • /sso/v1/sdk/session
  • /sso/v1/sdk/idp
  • /sso/v1/sdk/secure/session
  • /mfa/v1/requests
  • /mfa/v1/users/{userguid}/factors
  • /oauth2/v1/authorize
  • /oauth2/v1/userlogout
  • /oauth2/v1/consent
  • /fed/v1/user/request/login
  • /fed/v1/sp/sso
  • /fed/v1/idp/sso
  • /fed/v1/idp/usernametoken
  • /fed/v1/metadata
  • /fed/v1/mex
  • /fed/v1/sp/slo
  • /fed/v1/sp/initiatesso
  • /fed/v1/sp/ssomtls
  • /fed/v1/idp/slo
  • /fed/v1/idp/initiatesso
  • /fed/v1/idp/wsfed
  • /fed/v1/idp/wsfedsignoutreturn
  • /fed/v1/user/response/login
  • /fed/v1/user/request/logout
  • /fed/v1/user/response/logout
  • /fed/v1/user/testspstart
  • /fed/v1/user/testspresult
  • /admin/v1/SigningCert/jwk
  • /admin/v1/Asserter
  • /admin/v1/MyAuthenticationFactorInitiator
  • /admin/v1/MyAuthenticationFactorEnroller
  • /admin/v1/MyAuthenticationFactorValidator
  • /admin/v1/MyAuthenticationFactorsRemover
  • /admin/v1/TermsOfUseConsent
  • /admin/v1/MyTermsOfUseConsent
  • /admin/v1/TrustedUserAgents
  • /admin/v1/AuthenticationFactorInitiator
  • /admin/v1/AuthenticationFactorEnroller
  • /admin/v1/AuthenticationFactorValidator
  • /admin/v1/MePasswordResetter
  • /admin/v1/UserPasswordChanger
  • /admin/v1/UserLockedStateChanger
  • /admin/v1/AuthenticationFactorsRemover
  • /admin/v1/BypassCodes
  • /admin/v1/MyBypassCodes
  • /admin/v1/MyTrustedUserAgents
  • /admin/v1/Devices
  • /admin/v1/MyDevices
  • /admin/v1/TermsOfUses
  • /admin/v1/TermsOfUseStatements
  • /admin/v1/AuthenticationFactorSettings
  • /admin/v1/SsoSettings
  • /admin/v1/AdaptiveAccessSettings
  • /admin/v1/RiskProviderProfiles
  • /admin/v1/Threats
  • /admin/v1/UserDevices
  • /session/v1/SessionsLogoutValidator
  • /ui/v1/signin
Autenticação Básica
  • /admin/v1/HTTPAuthenticator
  • /admin/v1/PasswordAuthenticator
Tokens
  • /oauth2/v1/token
  • /oauth2/v1/introspect
  • /oauth2/v1/revoke
  • /oauth2/v1/device
Importar/Exportar
  • /job/v1/JobSchedules?jobType=UserImport
  • /job/v1/JobSchedules?jobType=UserExport
  • /job/v1/JobSchedules?jobType=GroupImport
  • /job/v1/JobSchedules?jobType=GroupExport
  • /job/v1/JobSchedules?jobType=AppRoleImport
  • /job/v1/JobSchedules?jobType=AppRoleExport
Importação em Massa
  • /admin/v1/Bulk
  • /admin/v1/BulkUserPasswordChanger
  • /admin/v1/BulkUserPasswordResetter
  • /admin/v1/BulkSourceEvents
Outro

Qualquer API que não esteja em um dos outros Grupos de API está incluída no Outro Grupo de API

Outras Restrições

Essas restrições são para Em Massa, Importar e Exportar para todas as camadas:

  • Tamanho do payload : 1 MB
  • API em massa: limite de 50 operações por chamada
  • Somente uma destas operações pode ser executada por vez:
    • Importar: Para Associações de Usuários, Grupos e Atribuição de Aplicativo
    • Sincronização completa dos aplicativos
    • API em massa
    • Exportar: Para Associações de Usuários, Grupos e Atribuição de Aplicativo
  • Importação de CSV: limite de 100 K de linhas por CSV e tamanho máximo de arquivo: 10 MB
  • Exportação CSV: limite de 100 K de linhas