Skip to content
Savorum API

Set a group mapping

POST
/api/v1/account/group-mappings
curl --request POST \
  --url http://127.0.0.1:8080/api/v1/account/group-mappings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "group": "example", "id": "example", "library_id": "example", "provider_id": "example", "role": "example" }'

Maps one provider group value to a library role. Instance administration. Browser session and CSRF protection are required for mutations, except invited local registration. Invitation secrets are returned once and must never be logged.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
group
required
string
id
required
string
library_id
required
string
provider_id
required
string
role
required
string
Examplegenerated
{
  "group": "example",
  "id": "example",
  "library_id": "example",
  "provider_id": "example",
  "role": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Completed

Media typeapplication/json
object
group
required
string
id
required
string
library_id
required
string
provider_id
required
string
role
required
string
Examplegenerated
{
  "group": "example",
  "id": "example",
  "library_id": "example",
  "provider_id": "example",
  "role": "example"
}

401

Section titled “401”

No valid session or API token (authentication-required), or the credential sent is invalid (invalid-credentials).

Media typeapplication/problem+json
object
code
required
string
detail
required
string
status
required
integer format: int64
title
required
string
type
required
string
key
additional properties
any
Examplegenerated
{
  "code": "example",
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}