Skip to content
Authrim

Validate region shard config

GET
/api/admin/settings/region-shards/validate
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/settings/region-shards/validate \
  --header 'Authorization: Bearer <token>'

Validates colocation group consistency for the current region shard config.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Region shard validation result.

Media type application/json
object
valid
boolean
errors
Array<string>
warnings
Array<string>
currentGeneration
integer
currentTotalShards
integer
groups
object
key
additional properties
object
totalShards
required
integer
>= 1
members
required
Array<string>
description
string
name
string
residency

Server-owned residency boundary that constrains region shard placement.

object
version
required
integer
Allowed values: 1
residencyPolicyId
required
string
residencyPartition
required
string
policyGeneration
required
integer
>= 1
allowedRegions
required
Array<string>
>= 1 items unique items
Allowed values: apac weur eeur enam wnam oc afr me
jurisdiction
required
string
nullable
Allowed values: eu fedramp
key
additional properties
recommendation
string
key
additional properties
Example 
{
  "valid": true,
  "errors": [],
  "warnings": [],
  "currentGeneration": 2,
  "currentTotalShards": 16,
  "groups": {
    "user_client": {
      "name": "user_client",
      "totalShards": 16,
      "members": [
        "users",
        "clients"
      ]
    }
  },
  "recommendation": "Configuration is valid."
}

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