Skip to content
Authrim

Update refresh token sharding config

PUT
/api/admin/settings/refresh-token-sharding
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/settings/refresh-token-sharding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "clientId": "client_123", "shardCount": 16, "notes": "scale up", "skip_sync_check": true }'

Creates a new refresh token shard generation. Global updates must match auth code shard count unless skip_sync_check is true.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
clientId
string
shardCount
required
integer
>= 1 <= 256
notes
string
skip_sync_check
boolean
key
additional properties
Example 
{
  "clientId": "client_123",
  "shardCount": 16,
  "notes": "scale up",
  "skip_sync_check": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Refresh token sharding updated.

Media type application/json
object
success
boolean
message
string
config
object
currentGeneration
integer
currentShardCount
integer
previousGenerations
Array<object>
object
generation
integer
shardCount
integer
shard_count
integer
activatedAt
integer format: int64
deprecatedAt
integer | null format: int64
createdBy
string
notes
string | null
key
additional properties
updatedAt
integer format: int64
updatedBy
string
key
additional properties
key
additional properties
Example 
{
  "success": true,
  "message": "Shard count updated from 8 to 16. New generation: 2",
  "config": {
    "currentGeneration": 2,
    "currentShardCount": 16,
    "previousGenerations": [
      {
        "generation": 1,
        "shardCount": 8,
        "deprecatedAt": 1769999999000
      }
    ],
    "updatedAt": 1770000000000,
    "updatedBy": "admin-api"
  }
}

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