POST | Create New Group

Prev Next

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

Description: Creates a new group within the senhasegura platform with specified configuration parameters and optional initial member assignments.

Request Parameters

  • Method: POST
  • Content-Type: application/json.
  • Authorization: Bearer token required.

Request Body Structure

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

Request Elements

Element Description
schemas SCIM group schema identifier (required).
displayName Human-readable group name (required).
externalId External system identifier for integration purposes.
description Optional descriptive text for group purpose.
members Optional array of initial group members.

Response Structure

{
  "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
    }
  ]
}

Status Codes

Status Code Description
201 Created Successful group creation with new group data.
400 Bad Request Invalid request syntax or missing required fields.
409 Conflict Group with specified name or externalId already exists.
401 Unauthorized Invalid or missing authentication token.

Error Response Format

All API endpoints return standardized error responses following SCIM protocol specifications.

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

Error Response Elements

Element Description
schemas SCIM error schema identifier.
status HTTP status code as string.
scimType SCIM-specific error classification.
detail Human-readable error description.