Skip to main content
POST
Create token group

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowClient Credentials
Token URL
https://auth.spirii.dk/realms/public-api/protocol/openid-connect/token

Headers

Idempotency-Key
string<uuid>
required

Client-generated unique key per operation intent (UUID). Same key + identical body replays the original response; same key + different body returns 409.

Body

application/json
name
string
required

Display name of the group

Required string length: 1 - 255
description
string

Free-text description of the group

Maximum string length: 1000
emsp_identity_id
string<uuid> | null

The EMSP identity the group belongs to. Leave it out or send null for the tenant's default identity

external_id
string

Your own identifier for the group. Filterable, never interpreted, and not required to be unique

Required string length: 1 - 255
metadata
object

Name/value pairs to attach to the group

network_ids
string<uuid>[]

Networks to assign to the group on creation

Maximum array length: 100

Response

The created group

group_id
string<uuid>
required

Stable token group id

tenant_id
string
required

Owning tenant, set by the platform

emsp_identity_id
string<uuid> | null
required

The EMSP identity the group belongs to. Null means the tenant's default identity

name
string
required
Required string length: 1 - 255
token_count
integer
required

Number of member tokens

Required range: x >= 0
status_summary
object
required

Number of member tokens in each status. The counts add up to token_count

audit
object
required
description
string | null
Maximum string length: 1000
external_id
string | null

Your own identifier for the group. Filterable, never interpreted, and not required to be unique

Maximum string length: 255
metadata
object | null

Name/value pairs you attach to the group

network_ids
string<uuid>[]

Networks assigned to the group. Managed through the network assignment operations