Provisionamento de System for Cross-domain Identity Management (SCIM)

Quando o Single Sign-on (SSO) for configurado, você pode configurar a Udemy para provisionamento System for Cross-domain Identity Management (SCIM 2.0) no Entra ID (antigo Azure AD) com a Udemy Business. Com isso, será possível provisionar, desprovisionar, criar grupos, gerenciar associações a grupos e alterar detalhes do perfil do usuário, como nome e endereço de e-mail, no Entra ID, que serão automaticamente atualizados na Udemy Business. Após essas ações, não será mais necessário atualizar o Entra ID e a Udemy Business separadamente, pois tudo será sincronizado a partir do Entra ID.

Observação: o Entra ID era anteriormente conhecido como Azure AD.

Para ativar o provisionamento SCIM na sua conta da Udemy Business, acesse sua conta e vá para Gerenciar > Configurações > Provisionamento (SCIM).

Clique em Iniciar configuração e siga as instruções para ativar o SCIM e gerar o Token secreto (token de portador) que você precisará inserir no Entra ID.

Observação:

• O SSO precisa estar ativado antes da ativação do SCIM
• O Single Sign-On e o provisionamento estão disponíveis para clientes com Plano Enterprise da Udemy Business.
• Os usuários provisionados pelo Entra ID não ocuparão uma licença até fazerem login no aplicativo da Udemy Business pela primeira vez. 
• As mudanças no provisionamento SCIM podem ser sincronizadas à Udemy Business a partir do Entra ID, e não o contrário. 
• Os usuários e grupos gerenciados por SCIM no Entra ID não podem ser alterados no aplicativo da Udemy Business; o SCIM é a única fonte de referência para dados de usuários e de grupos.
• Ainda é possível criar grupos manualmente na Udemy Business se você tiver usuários de que não precisa ou que quer retirar do Entra ID, como fornecedores ou funcionários temporários.

Configurar o provisionamento SCIM com Entra ID

1. Para ativar o provisionamento SCIM na sua conta da Udemy Business, acesse sua conta e vá para Gerenciar > Configurações > Provisionamento (SCIM).

2. Clique em Iniciar configuração, escolha seu provedor de identidade e siga as instruções para gerar o Token secreto (token de portador) que você precisará inserir no Entra ID.

3. Em seguida, acesse sua conta do Entra ID, o aplicativo SSO da Udemy Business e siga as etapas abaixo para configurar. Você também pode consultar o próprio guia de configuração da Microsoft sobre provisionamento SCIM com Entra ID para obter mais orientações.
Acesse a guia Provisionamento no seu portal Azure.
(Observação: udemyazure é um nome de teste que usamos nas capturas de tela abaixo para fins de ilustrar a configuração do SCIM. Você deve localizar o aplicativo que foi nomeado pela sua equipe ao configurar na sua própria instância) 

4. Escolha Automático como o Modo de provisionamento.   

5. Na seção Credenciais de Administrador:
O URL do Locatário é: https://yourdomain.udemy.com/scim/v2 (yourdomain é o URL da sua conta da Udemy Business)
Token Secreto: esse é o token de "portador" que você pode gerar ou visualizar dentro da sua conta da Udemy Business. (Acesse Gerenciar > Configurações > Acesso do usuário para obter o Token Secreto.)

6. Clique em Testar conexão para conferir se está funcionando corretamente.
Opcional: você pode inserir um endereço de e-mail, se quiser receber alertas do Azure sobre erros. 

7. Em Mapeamentos:
Verifique o mapeamento do atributo:

Confirme se os atributos obrigatórios abaixo foram adicionados no atributo customappsso, pois esses campos são obrigatórios para que o provisionamento SCIM funcione na Udemy.

Atributos compatíveis

Confirme se o atributo Switch([IsSoftDeleted], , "False", "True", "True", "False") está mapeado como ativo, permitindo que a desativação de usuários seja aprovada.

8. Role até a parte inferior de "Mapeamento de atributos de usuário" e ative Mostrar opções avançadas.

Selecione Editar lista de atributos para customappsso e ative Diferenciar maiúsculas e minúsculas para id e userName

9. Volte à tela principal de configuração do provisionamento:
Altere o botão do Status de provisionamento para Ativado. 

10. Escolha o Escopo de como você quer sincronizar seus usuários e grupos. 
Você só pode sincronizar usuários e grupos que estão atribuídos no aplicativo da Udemy Business se precisar restringir acesso a determinados funcionários ou departamentos. Ou você pode sincronizar todos os usuários e grupos se cada funcionário for ter um acesso. 
Para provisionar mais usuários e grupos com acesso à Udemy Business:

11. Clique em Usuários e grupos  

12. Clique em Adicionar usuário (que apresentará a opção de adicionar Usuários e Grupos)
Selecione todos os usuários ou grupos que você quer adicionar no aplicativo e clique em Selecionar.  

Solução de problemas

Em relação a Mapeamentos:  

Se você enfrentar esse erro durante o provisionamento:

{"schemas":["urn:ietf:params:scim:api:messages:2.0:Error"],"status":400,"detail":"{'emails': ['This field is required.']}"}

Altere o mapeamento do usuário.  

emails[type eq "work"].value precisa ser mapeado para userPrincipalName, se userPrincipalName for a localização do e-mail.

Se você acessar o perfil do usuário, poderá ver qual campo contém o e-mail.

Em caso de erros ao provisionar usuários, você pode ver mais detalhes pelos logs de provisionamento.

• Para consultar esse log, acesse o aplicativo da Udemy em Azure > Provisionamento > Logs de provisionamento > Procurar pelo usuário afetado > Solução de problemas e recomendações.
• Se necessário, abra um ticket de suporte e envie uma captura de tela dos logs de provisionamento do Azure, para que possamos analisar a falha.

 

Quando o Single Sign-on (SSO) for configurado, você poderá configurar o provisionamento System for Cross-domain Identity Management (SCIM) no OneLogin com a Udemy Business. Com isso, será possível provisionar, desprovisionar, criar grupos, gerenciar associações a grupos e alterar detalhes do perfil do usuário, como nome e endereço de e-mail no OneLogin, que serão automaticamente atualizados na Udemy Business. Após essas ações, não será mais necessário atualizar o OneLogin e a Udemy Business separadamente, pois tudo será sincronizado a partir do OneLogin.

Este artigo descreve como você pode configurar o provisionamento SCIM com OneLogin. 

Como ativar o provisionamento SCIM

Para ativar o provisionamento SCIM na sua conta da Udemy Business, acesse sua conta e vá para Gerenciar > Configurações > Provisionamento (SCIM).

Clique em Iniciar configuração e siga as instruções para ativar o SCIM e gerar o Token secreto (token de portador) que você precisará salvar no OneLogin.

Em seguida, acesse sua conta do OneLogin, o aplicativo de SSO da Udemy Business e siga as etapas abaixo para configurar. 

Outras informações sobre como provisionar usuários também está disponível na central de suporte do OneLogin.

1. No painel do administrador, clique na guia "Applications" (Aplicativos):
   
   
2. Navegue até a guia "Configuration" (Configuração). Nessa guia, insira o token de portador SCIM da sua conta da Udemy Business que foi gerado acima e configure como "Enabled" (Ativado):
   
   
3. Depois, navegue até a guia "Provisioning" (Provisionamento) e marque a caixa "Enable provisioning" (Ativar provisionamento):

Criar uma regra para sincronizar o grupo de um usuário com a Udemy Business

O OneLogin usa o conceito de "regras" para sincronizar um usuário com um grupo específico na sua conta da Udemy Business. Existem diversas maneiras de criar regras com base nos seus diferentes requisitos para a sincronização de grupos. Veja a seguir um exemplo específico de como criar uma regra para sincronizar um usuário com um grupo chamado "Engenheiros".

1. Navegue até a guia "Regras" e selecione "Adicionar regra":
   
2. Pré-requisito: antes de avançar para a próxima etapa, entre em contato com nossa equipe de suporte e peça para eles ativarem o sinalizador de recurso que permitirá que os grupos SCIM sejam extraídos da Udemy Business. Com esse recurso ativado, você pode extrair os grupos existentes da Udemy Business e acessá-los no OneLogin.
3. Na tela "Editar mapeamento", você poderá configurar a lógica da regra. Nesse exemplo, criamos uma regra onde a lógica é "Se o Grupo do usuário for 'Engenharia', então a ação é definir o grupo do usuário na Udemy Business como 'Engenheiros'".
   Para extrair os grupos "De existente" na Udemy Business, você precisará atualizar as autorizações.
   
   
4. Navegue até a guia "Parâmetros":
   
   
5. Clique no campo "Grupos":
   
   
6. Marque a caixa "Incluir no provisionamento de usuário" e salve:
   
   
7. Agora, após adicionar um usuário no OneLogin e configurar o grupo desse usuário como "Grupo de engenharia":
   
   
8. Depois que o usuário é adicionado ao aplicativo da Udemy Business e sincronizado, com base nessa regra, o usuário será adicionado ao grupo "Engenheiros" na sua conta da Udemy Business:

A Udemy Business oferece suporte ao gerenciamento automatizado de identidades e acesso de usuários e grupos com o padrão System for Cross-domain Identity Management (SCIM). O SCIM é usado por serviços de SSO (Single Sign-On, Login único) e por provedores de identidade para gerenciar pessoas em diversos aplicativos e ferramentas, incluindo a Udemy Business.

O SCIM pode ser uma boa opção para organizações que querem ampliar a escala e a segurança, bem como minimizar o atrito no gerenciamento de usuários para a Udemy Business.

O que você pode fazer com SCIM:

• Provisionar automaticamente licenças e acesso a usuários e grupo do seu provedor de identidade (provisionamento).
• Desativar automaticamente usuários e grupos do seu provedor de identidade (desprovisionamento).
• Reativar usuários que foram desprovisionados (desde que as informações de identificação pessoal do usuário não tenham sido anonimizadas).
• Atualizar detalhes de usuários: nome, endereço de e-mail.
• Criar, remover ou editar grupos
• Gerenciar associação a grupos (quando usuários mudam de grupo)

O que você não pode fazer com SCIM:

• Excluir as informações de identificação pessoal (PII) do usuário via SCIM em qualquer provedor de identidade.
• Sincronize os dados da Udemy Business de volta no provedor de identidade 
• Gerenciar funções (administrador, administrador de grupo, usuário).
• Atribuir licenças Udemy Business Pro.
• Observação: os usuários provisionados por SCIM não vão receber um convite por e-mail gerado automaticamente para reivindicar a licença da Udemy Business, como aconteceria se eles fossem convidados manualmente pelo portal de gerenciamento de usuários da Udemy Business.  Recomendamos que sua equipe de aprendizado envie um comunicado separadamente, explicando como eles podem acessar fazendo login pelo provedor de SSO. No entanto, os usuários que são reativados via SCIM vão receber um e-mail gerado automaticamente da Udemy informando que sua conta foi reativada.

Assim que você realizar uma das ações aceitas acima, os dados ou as alterações serão automaticamente atualizados na Udemy Business.

Principais pontos sobre a integração com SCIM para sua conta da Udemy Business

• A configuração da sua integração SCIM pode variar dependendo do provedor de identidade utilizado. 
• A Udemy Business é compatível com provisionamento SCIM para os principais provedores de identidade e serviços de SSO que oferecem gerenciamento de acesso e identidade.
• O provisionamento SCIM está disponível para clientes do Plano Enterprise que usam SSO.
• Os usuários provisionados por meio de SCIM no seu serviço de SSO não ocuparão uma licença até entrarem na Udemy Business ao fazerem login pela primeira vez. Quando os usuários são provisionados por meio de SCIM, mas ainda não fizeram o primeiro login, eles serão exibidos na página Todos os usuários, com o status Sem licença.
  • Para clientes que compraram licenças da Udemy Business Pro para todos os usuários, as licenças Pro serão atribuídas automaticamente quando os convites forem aceitos pelos usuários ou quando eles fizerem a autenticação via SSO/SCIM. 

• Observação: quando o SCIM é ativado, a Udemy usa o protocolo SCIM para mapeamento do atributo por meio do SAML.  Como groups e lmsUserID não são atributos de usuário do SCIM, eles não serão enviados via SAML se você os mapeou como parte de uma configuração apenas com SAML. Como groups não é um atributo de usuário do SCIM, ele não será enviado via SAML se você mapeou o atributo como parte de uma configuração apenas com SAML

Os usuários gerenciados via SCIM terão um rótulo SCIM em cinza ao lado do nome e do e-mail.  Os usuários com o status SCIM provisionado não vão consumir uma licença ativa até que façam o primeiro login:

Como ativar o provisionamento SCIM

Para ativar o provisionamento SCIM na sua conta da Udemy Business, acesse sua conta e vá para Gerenciar > Configurações > Provisionamento (SCIM).

Navegue até a seção Integração com SCIM. Em seguida, siga as instruções para ativar o SCIM, escolha seu provedor de identidade na lista suspensa e gere as credenciais (Nome de usuário e Senha ou token Segredo/Portador) que você precisará inserir no provedor de identidade como parte da configuração.

Dependendo de qual provedor de identidade você usa, siga as instruções no guia apropriado abaixo para concluir a configuração do SCIM.

Guia de configuração do Okta 

Guia de configuração do Azure AD

Guia de configuração do OneLogin

Para outros IdPs ou suas próprias ferramentas, consulte o  Guia de configuração da API SCIM da Udemy.

Como desativar o provisionamento SCIM

Para desativar o provisionamento SCIM na sua conta da Udemy Business (se você estiver mudando de provedor ou não precisar mais do SCIM), acesse Gerenciar > Configurações > Provisionamento (SCIM).

Navegue até a seção Integração com SCIM, clique no link Desativar integração e siga as instruções para desativar o SCIM. Isso desativará a integração no lado da Udemy Business, mas sua equipe de TI precisará desativar a integração no lado do provedor de identidade também. 

Você pode continuar usando a Udemy Business normalmente, mas agora precisará atualizar manualmente as informações de usuários e grupo dentro da plataforma.

 

Desprovisionar usuários com SCIM

Os usuários da Udemy Business que forem desprovisionados do seu provedor de identidade serão desativados dentro da Udemy Business.  Primeiro, implementamos essa "exclusão reversível" para que você possa preservar o histórico do aluno, caso precise reativar esses usuários posteriormente e para prevenir anonimização acidental e irreversível dos dados de um usuário.  Se você quiser excluir permanentemente um usuário e todos os dados dele, siga as instruções abaixo:

Excluir as PII de alunos gerenciados via SCIM

Se você quiser desconectar um aluno do gerenciamento pelo seu IdP com SCIM, primeiro desprovisione o aluno no seu SSO Active Directory, para depois poder excluir as PII dele na sua conta da Udemy Business. 

• Veja como anonimizar um aluno na Udemy Business.

Se você precisar gerenciar um estudante diretamente pela conta da Udemy Business e não pelo IdP com SSO, ou se você não quiser excluir as PII dele, entre em contato com nossa equipe de suporte para obter ajuda.

Este guia apresenta as etapas necessárias que clientes existentes do Okta e da Udemy Business precisam seguir para configurar o provisionamento automático, o desprovisionamento, as atualizações de perfis e o gerenciamento de usuários e grupos da Udemy Business usando o System for Cross-domain Identity Management (SCIM 2.0).

Observações:

• Se você já tiver habilitado o login do SSO para a Udemy Business no Okta, não precisará reconfigurar o SSO novamente. Basta procurar pela guia Provisionamento em Aplicações no Okta para configurar o SCIM. 
• Se alguém da sua equipe configurou o SSO a partir de uma configuração manual, você precisa adicionar o nosso novo aplicativo da Udemy Business na sua conta do Okta. Você o encontrará em Aplicativos quando procurar Udemy Business. Como essa é uma nova versão do nosso aplicativo no Okta, os clientes existentes podem precisar reconfigurar o Single Sign-On (SSO) antes de habilitar o provisionamento SCIM (veja as instruções passo a passo abaixo).
• Os usuários provisionados pelo Okta não ocuparão uma licença ativa até fazerem login no aplicativo da Udemy Business pela primeira vez.
• Os usuários e grupos gerenciados pelo SCIM somente podem ser alterados no Okta.
• Quando o SCIM é ativado, a Udemy usa o protocolo SCIM para mapeamento do atributo por meio do SAML. Como groups não é um atributo de usuário do SCIM, ele não será enviado via SAML se você mapeou o atributo como parte de uma configuração apenas com SAML

Sumário

• Recursos
• Requisitos
• Etapas para configuração
• Descoberta de esquema
• Dicas para solução de problemas

Recursos

Os seguintes recursos de provisionamento do SCIM são compatíveis:

• Provisionar usuários do Okta
  • Os usuários atribuídos ao aplicativo da Udemy Business no Okta serão provisionados na Udemy Business.
  • Os usuários não vão receber um convite de e-mail gerado automaticamente se forem provisionados via SCIM no Okta.
• Atualizações de perfil por Push
  • Atualizações feitas ao perfil do usuário por meio do Okta serão enviadas por push à Udemy Business para os usuários que estão associados com a Udemy Business no Okta.
• Desativação de usuário por Push
  • Desativar o usuário ou desabilitar o acesso do usuário ao aplicativo por meio do Okta desativará o usuário na Udemy Business e o removerá de todos os grupos.
  • Observação: os dados de aprendizado dos usuários desativados serão retidos para fins de geração de relatórios ou reativação futura.  Para excluir permanentemente um usuário desativado e gerenciado por SCIM, primeiro você precisa desfazer a conexão SCIM desse usuário, algo com que a Udemy Business pode ajudar. 
• Reativar usuários
  • Os usuários podem ser reativados na Udemy Business reatribuindo o aplicativo àquele usuário por meio do Okta.
  • Os usuários reativados vão receber um e-mail gerado automaticamente da Udemy informando que foram reativados.
• Push de grupo
  • Os grupos e seus associados serão enviados à Udemy Business por push. O gerenciamento de grupos está limitado aos grupos enviados originalmente por push a partir do Okta, pois não enviamos informações de grupos criados na Udemy Business.

Os usuários gerenciados via SCIM terão um rótulo SCIM em cinza ao lado do nome e do e-mail.  Os usuários com o status SCIM provisionado não vão consumir uma licença ativa até que façam o primeiro login:

 

Etapas para configuração 

Se você não ativou o SSO para Okta ou se a nossa equipe configurou o SSO manualmente, siga estas etapas de configuração do Okta SSO primeiro.

• Para evitar tempo de inatividade do SSO, oculte o bloco da Udemy Business no seu painel do Okta até que a configuração do SSO e do SCIM esteja concluída. 
• Ao lado de Visibilidade do aplicativo, clique em "Não exibir ícone do aplicativo para os usuários"

1. Para começar, clique na guia Provisioning (Provisionamento), depois em Configure API integration (Configurar integração de API).

2. Clique em Enable API Integration (Ativar integração de API) e adicione o seu subdomínio, CLIENT_ID como nome de usuário e SECRET_ID como a senha. 

[Para gerar ou visualizar essas credenciais na sua conta da Udemy Business, acesse a página Provisionamento (SCIM) em Gerenciar -> Configurações.]

3. Clique em Test API Credentials (Testar credenciais da API) e você verá uma mensagem indicando que concluiu com sucesso sua integração com o SSO. Caso contrário, envie uma mensagem à equipe de suporte da Udemy Business informando a mensagem de erro que foi exibida.

4. Clique em Save (Salvar) e você será redirecionado para a página de configuração Provisioning (Provisionamento) do aplicativo.

5. No link To App (Para aplicativo), clique em Edit (Editar) para habilitar os recursos individuais. Para usar todos os recursos, recomendamos habilitar as opções Create Users (Criar usuários), Update User Attributes (Atualizar atributos de usuários) e Deactivate Users (Desativar usuários) nessa página.

6. Clique em Save (Salvar).

7. Clique na guia Assignments (Atribuições) para atribuir a Udemy Business a usuários únicos ou a grupos inteiros. Os usuários atribuídos serão automaticamente provisionados após serem adicionados, modificados quando ocorrerem alterações em seus perfis e desativados quando forem removidos das atribuições.

8. Clique na guia Push Groups (Grupos por Push) para enviar grupos e as informações de seus participantes para a Udemy Business.

9. Clique em + Push Groups (+ Grupos por Push) e selecione os grupos que você quer enviar à Udemy Business por push.

Você poderá selecionar cada grupo ou criar uma regra automática.

10. Selecione os critérios de pesquisa do grupo e preencha as informações solicitadas para os grupos que você quer enviar para a Udemy Business.

11. Após selecionar o grupo, marque Push group memberships immediately (Enviar participantes do grupo por push imediatamente) para enviar não apenas o grupo, mas também seus participantes assim que você selecionar o grupo, e clique em Save (Salvar).

12. Siga as etapas anteriores para selecionar todos os grupos que você deseja enviar à Udemy Business.

Observação: a Udemy Business não permitirá mudanças a usuários ou grupos gerenciados por SCIM após a configuração.

Visão geral

O Sistema para gerenciamento de identidade entre domínios (SCIM) é uma API padrão para automatizar o provisionamento/desprovisionamento de usuário e grupo, bem como atualizar os dados de usuário e grupo a partir do Provedor de identidade (IdP) do cliente na conta da Udemy Business.  O SCIM é compatível com diversos provedores de identidade, como Okta, Azure AD e OneLogin.  Você também pode usar a API SCIM da Udemy Business para outros IdPs ou ferramentas internas.

Se a sua organização usa um dos seguintes IdPs, consulte nossos guias abaixo sobre a configuração do SCIM:

• Configurar o provisionamento SCIM com Okta
• Configurar o provisionamento SCIM com Azure Active Directory (AD)
• Configurar o provisionamento SCIM com OneLogin

O SCIM usa uma API REST padrão com dados formatados em JSON. A Udemy Business é compatível com a versão 2.0 do SCIM padrão. A API está disponível para todos os clientes do plano Enterprise.

A API SCIM da Udemy Business é compatível com os seguintes recursos: 

• Provisionar usuários
• Desprovisionar usuários (desativação)
• Alterar endereços de e-mail
• Alterar detalhes do usuário
• Provisionar grupos
• Adicionar/remover usuários de grupos

Descrição do protocolo SCIM

O protocolo SCIM é um protocolo REST no nível da aplicação para provisionar e gerenciar dados de identidade na web. O protocolo é cliente-servidor, onde o cliente é o provedor de identidade (IdP) e o servidor é a Udemy Business.

O fluxo básico é o seguinte:

• Quando o acesso à Udemy Business é concedido ao usuário no IDP pelo cliente, o IdP nos envia uma solicitação para verificar se o usuário específico existe no nosso banco de dados. Ele emite uma solicitação de busca de usuário por um atributo como userName ou email.
• Se o usuário não existe, o IdP envia uma solicitação para criar um usuário.
• Se o usuário existe, o IdP envia uma solicitação de atualização para o usuário.
• Quando o acesso à Udemy Business é revogado, o IdP envia uma solicitação para desativar o usuário do nosso banco de dados.
• O IdP também pode enviar solicitações de alteração dos detalhes do usuário.

Como acessar a API?

Para obter as credenciais de autorização para conectar à API SCIM, você deverá configurar a integração do SCIM na página Gerenciar -> Configurações -> Provisionamento (SCIM) da sua conta da Udemy Business. Observação: apenas administradores têm acesso a essa página. 

Clique em Iniciar configuração.

Na próxima etapa, selecione Escolher provedor, depois Personalizado.

Clique em Gerar token.

Nessa tela, clique em Copiar para copiar o token do portador para a área de transferência.

Você deverá incluir o cabeçalho HTTP Authorization com o token do portador nas suas solicitações, por exemplo:

GET /scim/v2/Users HTTP/1.1

 Host: myorganization.udemy.com

 Accept: application/scim+json

 Authorization: Bearer <insira seu token de portador aqui>

 Content-Type: application/scim+json

A API SCIM da Udemy Business usa o protocolo HTTP e está disponível apenas via uma conexão HTTPS segura.

O URL básico da API é https://<organization>.udemy.com/scim/v2/. 

Se você estiver desenvolvendo uma aplicação para interagir com a API SCIM da Udemy Business, é recomendável consultar os SCIM RFCs incluídos ao fim deste documento. A implementação da API SCIM da Udemy Business está em conformidade com o padrão.

Endpoints da API SCIM

Endpoints informacionais

Esses endpoints são informativos e servem para configurar os clientes. Eles não exigem autenticação, então não é preciso incluir o cabeçalho Authorization ao acessá-los.

GET /ServiceProviderConfig

Retorna detalhes sobre a implementação do SCIM da Udemy Business, incluindo quais métodos são compatíveis.

GET /Schemas

Retorna informações sobre os esquemas compatíveis com nossa implementação de SCIM. Os esquemas compatíveis são Users e Groups.

GET /Schemas/Users

Retorna todos os atributos compatíveis para os recursos User.

GET /Schemas/Groups

Retorna todos os atributos compatíveis para os recursos Group.

Endpoints de usuário

Usando esses endpoints, é possível listar usuários, filtrar por atributos, adicionar novos usuários, atualizar informações de usuários ou desativar/anonimizar usuários. Lembre-se de que você só poderá acessar usuários que foram criados usando a API SCIM, os usuários criados dentro da Udemy Business não estarão disponíveis a menos que você os reconcilie pelo SCIM. Veja mais detalhes sobre reconciliação abaixo.

Atributos compatíveis

Observação: se você especificar qualquer outro atributo que não esteja nessa lista, ele será ignorado.

Quando o SCIM é ativado, a Udemy usa o protocolo SCIM para mapeamento do atributo por meio do SAML. Como groups não é um atributo de usuário do SCIM, ele não será enviado via SAML se você mapeou o atributo como parte de uma configuração apenas com SAML

GET /Users

Retorna uma lista paginada de usuários, 12 usuários por página como padrão. Você pode passar os parâmetros count e startIndex para paginar o conjunto de resultados. Por exemplo:

GET /scim/v2/Users?startIndex=1&count=100 HTTP/1.1

 Host: myorganization.udemy.com

 Accept: application/scim+json

 Authorization: Bearer <insira seu token de portador aqui>

• startIndex é o índice baseado em 1 do primeiro resultado no conjunto atual de resultados (compensação)
• count é o número de recursos retornados em uma página de resposta de lista (limite). Até 1.000 usuários podem ser recuperados em uma única solicitação. Se esse item for omitido, o padrão será 12.

GET /Users?filter=

Esse endpoint é usado para filtrar usuários por atributos específicos. Por exemplo, é possível pesquisar pelo atributo userName:

GET /Users?filter=userName eq "gloria.graynor”

Observação: no exemplo acima, você precisará fazer a codificação URL dos parâmetros, para que o URL seja:
GET /Users?filter=userName%20eq%20%22gloria.graynor%22

Isso retornará uma lista de recursos do usuário. Se não houver resultados, uma lista vazia será exibida.

Os filtros compatíveis são:

• userName
• externalID
• emails[type eq=”work”]

Os operadores compatíveis são:

• and
• eq

Resposta:

• Código 200 do status HTTP com a lista de entidades em sucesso
• Código 501 do status HTTP se um filtro incompatível for fornecido

POST /Users

Esse endpoint é usado para criar (provisionar) novos usuários na Udemy Business. 

A resposta conterá um atributo id que deve ser usado ao referir esse usuário em todas as solicitações subsequentes.

Observação:

• Novos usuários criados dessa maneira não consumirão uma licença até que o usuário faça login pela primeira vez.
• Se havia um convite pendente para usuário, ele será usado nesse momento.
  O usuário será adicionado a grupos e atribuído à função/às tarefas de curso adequadas de acordo com o que estiver especificado no convite.
• Uma tentativa de criar um usuário que já existe na Udemy Business fará com que o usuário se torne gerenciado pelo SCIM (ele será exibido com um pequeno ícone de link nas páginas Gerenciar usuários). O status e o uso de licença do usuário não serão alterados. Se o usuário estava ativo, permanecerá assim, e se o usuário estava desativado, continuará desativado.

Resposta:

• Código 201 do status HTTP e o recurso do usuário em sucesso
• Código 409 do status HTTP se o membro com o mesmo userName já existe na Organização
• Código 400 do status HTTP com os detalhes do erro no corpo da resposta se a solicitação não foi aprovada na validação

GET /Users/<id>

Esse endpoint é usado para recuperar detalhes de um usuário especificado. O parâmetro id na solicitação acima é um identificador exclusivo que retornou quando o usuário foi criado usando o SCIM ou ao listar todos os usuários existentes.

Resposta:

• Código 200 do status HTTP com o recurso do usuário em sucesso
• Código 404 do status HTTP se o usuário não foi encontrado

PUT /Users/<id>

Esse endpoint é usado para substituir (sobrescrever) os detalhes do usuário na Udemy Business. Se especificado, o atributo active pode ser usado para desativar ou reativar o usuário.

Resposta:

• Código 200 do status HTTP e recurso do usuário atualizado
• Código 404 do status HTTP se o usuário não existe. 
• Código 400 do status HTTP em caso de tentativa de desativação de um proprietário da organização.

PATCH /Users/<id>

Esse endpoint é usado para fazer atualizações parciais nos detalhes do usuário em nosso sistema, ou seja, você pode usar para alterar apenas alguns atributos do usuário. Ele é oposto ao PUT, que substitui todo o usuário. 

Pode conter o atributo active, que fará com que o usuário seja desativado ou reativado.

• O corpo de cada solicitação DEVE conter o atributo "schemas" com o valor URI de "urn:ietf:params:scim:api:messages:2.0:PatchOp".
• O corpo de uma solicitação HTTP PATCH DEVE conter o atributo "Operations", cujo valor é uma matriz de uma ou mais operações PATCH.  Cada objeto de operação PATCH DEVE conter exatamente um membro "op", cujo valor indica a operação a ser realizada e PODE ser "add", "remove" ou "replace".
• O atributo "path" pode estar vazio. Nesse caso, "value" deve ser um dicionário no formato {"path": "value"}.

Resposta:

• Código 200 do status HTTP com o recurso do usuário atualizado em sucesso
• Código 404 do status HTTP se o usuário não foi encontrado
• Código 400 do status HTTP se há a tentativa de desativar um proprietário da organização ou em caso de uma operação inválida.

Endpoints do grupo

Atributos compatíveis

Atributo SCIM	Obrigatório?	Descrição
displayName	Sim	Título do grupo. Deve ser exclusivo dentre todos os grupos da Udemy Business.
externalId	Não	O externalId do grupo do provedor de identidade

Observação: se você especificar qualquer outro atributo que não esteja nessa lista, ele será ignorado.

GET /Groups

Esse endpoint é usado para obter uma lista paginada de todos os grupos provisionados. Inclua os parâmetros da cadeia de consulta startIndex e count para paginar os resultados. 

Lembre-se de que apenas grupos criados usando o SCIM serão retornados. Os grupos criados na Udemy Business não aparecerão.

GET /Groups?filter=

Esse endpoint é usado para filtrar grupos por atributos específicos. Por exemplo, é possível pesquisar pelo atributo displayName:

GET /Groups?filter=displayName eq "Marketing”

Isso retornará uma lista de recursos do grupo. Se não houver resultados, uma lista vazia será exibida.

Você precisará fazer a codificação URL dos parâmetros, para que a solicitação seja:
GET /Groups?filter=displayName%20eq%20%22Marketing%22

Os filtros compatíveis são:

• displayName
• externalId
• Id
• member.value

Os operadores compatíveis são:

• and
• eq

Resposta:

• Código 200 do status HTTP com a lista de entidades em sucesso
• Código 501 do status HTTP se um filtro incompatível for usado

POST /Groups

Esse endpoint é usado para criar (provisionar) novos grupos na Udemy Business. 

Resposta:

• Código 409 do status HTTP se o grupo provisionado com o mesmo nome já existe na organização, o 409 (Conflito) será exibido com um código de erro scimType de uniqueness.
• Quando o grupo for criado com sucesso, retornaremos a representação completa do grupo com o código 201 do status HTTP (Criado) juntamente com o cabeçalho Location que contém o URL do recurso de criação do grupo.

GET /Groups/<id>

Esse endpoint é usado para obter os detalhes do grupo da Udemy Business. 

Resposta:

• Código 200 do status HTTP e um recurso de grupo
• Código 404 do status HTTP se o grupo não foi encontrado

PUT /Groups/<id>

Esse endpoint é usado para substituir os detalhes do grupo da Udemy Business.

Resposta:

• Código 200 do status HTTP e recurso do grupo atualizado 
• Código 404 do status HTTP se o grupo não existe. 

PATCH /Groups/<id>

Esse endpoint é usado para fazer atualizações parciais nos detalhes do grupo da Udemy Business. 

O endpoint PATCH é mais complicado que outros, pois é compatível com diferentes tipos de operação (e é possível fazer combinações):

• replace operação que altera o valor especificado. No nosso caso, é o nome ou membros do grupo.
• remove operação que remove um membro do grupo.
• add operação que adiciona membros ao grupo.

As regras são as seguintes:

• Nunca removemos membros não provisionados do grupo (no caso da operação de membros "replace", por exemplo).
• A solicitação PATCH, independentemente do número de operações, DEVERÁ ser considerada atômica.

As validações de entrada são as seguintes:

• O corpo de cada solicitação DEVE conter o atributo "schemas" com o valor URI de "urn:ietf:params:scim:api:messages:2.0:PatchOp".
• O corpo de uma solicitação HTTP PATCH DEVE conter o atributo "Operations", cujo valor é uma matriz de uma ou mais operações PATCH.  Cada objeto de operação PATCH DEVE conter exatamente um membro "op", cujo valor indica a operação a ser realizada e PODE ser "add", "remove" ou "replace".
• O atributo "path" pode estar vazio. Nesse caso, "value" deve ser um dicionário no formato {"path": "value"}.
• Para a operação "Remove", o caminho "members" é obrigatório.
• Para a operação "Add", os caminhos "members" ou "externalId" devem estar presentes.
• Para a operação "Replace", o caminho "members" pode estar presente. Se não estiver, significa que vamos substituir os detalhes do grupo (como o nome do grupo), mas não os membros.

Nota:

• A atribuição/o cancelamento de atribuição de usuários a um grupo ocorre de maneira assíncrona, então as mudanças não serão refletidas imediatamente na Udemy Business.
• Não oferecemos compatibilidade com grupos aninhados, então eles serão ignorados durante essa solicitação.

Resposta:

• Código 204 do status HTTP se a operação foi bem sucedida.
• Código 404 do status HTTP se o grupo não existe.
• Código 404 do status HTTP com os detalhes do erro se houve uma tentativa de atribuir um usuário que não é membro da organização a um grupo.
• Código 400 do status HTTP com os detalhes do erro no corpo da resposta se a solicitação não foi aprovada na validação

DELETE /Groups/<id>

Esse endpoint é usado para remover ou desprovisionar um grupo na Udemy Business. Excluir um grupo não apagará os usuários desse grupo. Os usuários simplesmente serão removidos do grupo excluído.

As regras são as seguintes:

• Se o grupo contém membros não provisionados, remova os usuários provisionados do grupo, exclua o registro "OrganizationSCIMGroup".

Resposta:

• Código 204 do status HTTP se a operação foi bem sucedida.
• Código 404 do status HTTP se o grupo não existe.

Leia mais

• Visão geral do SCIM: http://www.simplecloud.info
• RFC 7642, SCIM – Definições, visão geral, conceitos e requisitos: https://tools.ietf.org/pdf/rfc7642.pdf
• RFC 7643, SCIM – Esquema principal: https://tools.ietf.org/pdf/rfc7643.pdf
• RFC 7644, SCIM – Protocolo: https://tools.ietf.org/pdf/rfc7644.pdf

Temos duas maneiras para conceder aos usuários acesso à sua conta da Udemy Business: por Single Sign-on (SSO) ou envio de convite pelos administradores/administradores de grupo.

Esse recurso é uma opção adicional se você usar o processo de convite, com o qual os usuários terão uma maneira de acionar por conta própria o convite por e-mail a partir da página de destino da sua conta (por exemplo, company.udemy.com), usando um domínio de endereço de e-mail aprovado/verificado que você, o administrador, predefiniu.

Como aprovar um domínio de endereço de e-mail

Na página Configurações, em Acesso do domínio de e-mail, os administradores podem especificar um domínio (ou vários) de endereço de e-mail aprovado para acessar a sua conta da Udemy Business.

Esse recurso está disponível para os planos Team e Enterprise, mas a configuração do domínio de e-mail aprovado na página Acesso do domínio de e-mail só pode ser acessada por proprietários e administradores, não por administradores de grupo.

Compartilhar o URL da página inicial da sua conta para os usuários se inscrevem

Você pode compartilhar o URL da página de destino da sua conta da Udemy Business com os usuários e grupos na organização que devem ter acesso, por exemplo, via Slack, e-mail, wiki, intranet ou simplesmente adicionando o link no seu sistema de gestão de aprendizado (LMS).

Quando um usuário acessar o URL da página de destino da sua conta, ele poderá informar o endereço de e-mail e se inscrever, caso o endereço informado corresponda a um domínio aprovado predefinido pelo administrador.

Observação: para manter uma plataforma segura e confiável, exigimos a validação do e-mail ao se inscrever em uma nova conta. Se você tiver problemas, consulte as etapas de resolução de problemas.

Depois de inserir o endereço de e-mail aprovado, ele receberá uma instrução na tela para procurar o convite para verificação da conta.

Uso e verificação de licença

Os usuários precisam concluir a inscrição em suas contas para reivindicar uma licença. 

Se não houver licenças disponíveis, o usuário verá a mensagem abaixo, instruindo-o a entrar em contato com o gerente ou com o departamento de TI.

Os usuários precisarão verificar as informações da conta pelo e-mail de verificação que eles receberam, que contém um link. O link de verificação expira em uma hora*. Após verificar a conta, eles poderão se inscrever, escrevendo o nome, e-mail e senha.

*Os usuários com Single Sign-On (SSO)/System for Cross-Domain Management (SCIM) não passarão por esse fluxo de verificação.

Se o endereço de e-mail do usuário não corresponder a um domínio aprovado, ele verá a mensagem abaixo e não conseguirá se inscrever.

Se não houver licenças disponíveis, o usuário verá a mensagem abaixo, instruindo-o a entrar em contato com o gerente ou com o departamento de TI.

Os usuários que se inscreverem usando o processo de domínio de e-mail aprovado serão exibidos na tela Convites pendentes em Gerenciar usuários, mas serão destacados com a observação "Convidado via e-mail aprovado".

Esse recurso está disponível para os planos Team e Enterprise, mas a configuração do domínio de e-mail aprovado na página Acesso do usuário só pode ser acessada por proprietários e administradores, não por administradores de grupo.