Skip to content
Authrim

Get client-scoped settings for a category.

GET
/api/admin/clients/{clientId}/settings/{category}
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/clients/example/settings/example \
  --header 'Authorization: Bearer <token>'

Returns all settings in a category at client scope after checking that the category supports client overrides, the admin can view that category, and the client belongs to an accessible tenant.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
clientId
required
string

Client identifier.

category
required
string

Settings category name that supports client scope.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Settings v2 read response.

Media type application/json

Settings v2 category read result returned by the settings manager. A value comes from the requested scope, else from the scopes it inherits from (a client’s tenant, then the platform, where the category allows those scopes), else from the deployment’s environment variable, else from the built-in default. sources says where each value came from, and inherited gives what each setting would be if the requested scope set nothing.

object
category
string
scope
object
key
additional properties
version

Version of the requested scope’s document, for optimistic concurrency.

string
values

Effective value of each setting at the requested scope.

object
key
additional properties
sources

Where each value came from. kv means it is set at the requested scope; tenant and platform mean it is inherited from that scope.

object
key
additional properties
string
Allowed values: kv tenant platform env default
inherited

What each setting would be if the requested scope set nothing.

object
values
required
object
key
additional properties
sources
required
object
key
additional properties
string
Allowed values: tenant platform env default
key
additional properties
Example 
{
  "category": "oauth",
  "scope": {
    "type": "client",
    "id": "client_123",
    "tenantId": "tenant_123"
  },
  "values": {
    "oauth.access_token_expiry": 300,
    "oauth.id_token_expiry": 900
  },
  "sources": {
    "oauth.access_token_expiry": "kv",
    "oauth.id_token_expiry": "tenant"
  },
  "inherited": {
    "values": {
      "oauth.access_token_expiry": 900,
      "oauth.id_token_expiry": 900
    },
    "sources": {
      "oauth.access_token_expiry": "tenant",
      "oauth.id_token_expiry": "tenant"
    }
  },
  "version": "v1"
}

Headers

Section titled “Headers ”
X-Authrim-Log-Consistency
string
Allowed values: snapshot eventual local_hot_only

Snapshot for the remote scheduled view; eventual when Pipeline visibility can lag ingestion; local_hot_only for local scheduled staging without a remote Catalog.

X-Authrim-Log-Pending-Deliveries
integer

Tenant deliveries not yet confirmed visible. Omitted for self-service subjects. Zero does not guarantee immediate Pipeline visibility.

X-Authrim-Log-Complete
boolean

True only for a complete bounded snapshot query. Pipeline responses remain false; incomplete reads return 503.

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

503

Section titled “503 ”

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