コンテンツにスキップ
Authrim

Update session shard settings

PUT
/api/admin/settings/session-shards
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/settings/session-shards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "shards": 16 }'

Stores a new session shard count in AUTHRIM_CONFIG. Changes affect new sessions only.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
shards
required
integer
>= 1 <= 256
key
additional properties
Example 
{
  "shards": 16
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Session shard count updated.

Media type application/json
object
success
boolean
shards
integer
note
string
key
additional properties
Example 
{
  "success": true,
  "shards": 16,
  "note": "Session shard count updated. Changes affect new sessions only."
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}