Creation of a service providing the SCIM Protocol

This release note is written in English and Portuguese, scroll to the end to access both languages.

Esta release note está escrita em Inglês e Português, role a página até o final para ter acesso às duas linguagens.

---

Creation of a Service Providing the SCIM Protocol

What is the SCIM API and its benefits?

The SCIM (System for Cross-domain Identity Management) API allows users to perform Access Management activities within the StackSpot Portal through HTTP methods (GET, POST, PUT, PATCH, DELETE). This enables automated and streamlined identity management, especially useful for enterprise accounts.

How does it work?

The SCIM API offers comprehensive functionality for managing identities and access permissions. Below is a detailed description of its usage:

• Implementation

  To implement the SCIM API, users must authenticate using their service credentials. Follow these steps:

  1. Authentication: Only available for enterprise accounts due to authentication restrictions.
  2. Activate Permissions: Ensure that 'scim_use' permission is activated. Contact your account administrator if you cannot create a service credential.
  3. Retrieve Credentials: Copy 'client id', 'client key', and 'realm' for environment variables. If lost, revoke and recreate the credentials.
  4. Set Access Token: Use the following command to set the access token as an environment variable:

     export JWT=$(curl -s "https://idm.stackspot.com/$REALM/oidc/oauth/token" -H 'Content-Type: application/x-www-form-urlencoded' -d 'grant_type=client_credentials' -d "client_id=$CLIENT_ID" -d "client_secret=$CLIENT_KEY" | jq -r '.access_token')

• User Journeys

  Users can interact with the SCIM API through various StackSpot channels (CLI and/or Portal) and StackSpot AI. For example:

  • Create: Add new users or groups.
  • Update: Modify user or group attributes.
  • Delete: Remove users or groups.
  • Retrieve: Fetch details of users or groups.

Support Content

For more details, refer to the API Specification and other documentation provided:

• StackSpot IAM - Scim Provider API (1.0)

Criação de um Serviço que Fornece o Protocolo SCIM

O que é a API SCIM e seus benefícios?

A API SCIM (System for Cross-domain Identity Management) permite que os usuários realizem atividades de Gerenciamento de Acessos dentro do Portal StackSpot através de métodos HTTP (GET, POST, PUT, PATCH, DELETE). Isso possibilita um gerenciamento de identidade automatizado e simplificado, especialmente útil para contas empresariais.

Como funciona?

A API SCIM oferece funcionalidades abrangentes para gerenciar identidades e permissões de acesso. Abaixo está uma descrição detalhada de seu uso:

• Implementação

  Para implementar a API SCIM, os usuários devem autenticar-se usando suas credenciais de serviço. Siga estes passos:

  1. Autenticação: Disponível apenas para contas empresariais devido às restrições de autenticação.
  2. Ativar Permissões: Assegure-se de que a permissão 'scim_use' está ativada. Entre em contato com o administrador da sua conta se não conseguir criar uma credencial de serviço.
  3. Recuperar Credenciais: Copie 'client id', 'client key' e 'realm' para variáveis de ambiente. Se perdidas, revogue e recrie as credenciais.
  4. Definir Token de Acesso: Use o seguinte comando para definir o token de acesso como uma variável de ambiente:

     export JWT=$(curl -s "https://idm.stackspot.com/$REALM/oidc/oauth/token" -H 'Content-Type: application/x-www-form-urlencoded' -d 'grant_type=client_credentials' -d "client_id=$CLIENT_ID" -d "client_secret=$CLIENT_KEY" | jq -r '.access_token')

• Jornadas do Usuário

  Os usuários podem interagir com a API SCIM através de vários canais da StackSpot (CLI e/ou Portal) e StackSpot IA. Por exemplo:

  • Criar: Adicionar novos usuários ou grupos.
  • Atualizar: Modificar atributos de usuários ou grupos.
  • Deletar: Remover usuários ou grupos.
  • Recuperar: Buscar detalhes de usuários ou grupos.

Conteúdos de Apoio

Para mais detalhes, consulte a Especificação da API e outros documentos fornecidos:

• StackSpot IAM - Scim Provider API (1.0)