POST | Criar novo grupo

Prev Next

Endpoint: POST {{senhasegura_url}}/iso/scim/v2/Groups

Descrição: Cria um novo grupo na plataforma senhasegura com parâmetros de configuração especificados e atribuição opcional de membros iniciais.

Parâmetros da Requisição

  • Método: POST
  • Content-Type: application/json.
  • Authorization: Token Bearer obrigatório.

Estrutura do Corpo da Requisição

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "displayName": "string",
  "externalId": "string",
  "description": "string",
  "members": [
    {
      "value": "string",
      "type": "User"
    }
  ]
}

Elementos da Requisição

Elemento Descrição
schemas Identificador do schema de grupo SCIM (obrigatório).
displayName Nome legível do grupo (obrigatório).
externalId Identificador de sistema externo para integração.
description Texto descritivo opcional para o propósito do grupo.
members Array opcional de membros iniciais do grupo.

Estrutura da Resposta

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "id": "string",
  "displayName": "string",
  "externalId": "string",
  "description": "string",
  "members": [
    {
      "value": "string",
      "type": "User",
      "primary": boolean
    }
  ]
}

Códigos de Status

Código de Status Descrição
201 Created Grupo criado com sucesso e dados do novo grupo retornados.
400 Bad Request Sintaxe inválida ou campos obrigatórios ausentes.
409 Conflict Grupo com o nome ou externalId especificado já existe.
401 Unauthorized Token de autenticação inválido ou ausente.

Formato de Resposta de Erro

Todos os endpoints da API retornam respostas de erro padronizadas seguindo as especificações do protocolo SCIM.

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
  "status": "string",
  "scimType": "string",
  "detail": "string"
}

Elementos da Resposta de Erro

Elemento Descrição
schemas Identificador do schema de erro SCIM.
status Código de status HTTP como string.
scimType Classificação de erro específica do SCIM.
detail Descrição legível do erro.