Orishare
API reference

Read client origins, grant policy and admission limits

GET
/client_configuration

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/client_configuration"
{  "environment_id": "string",  "version": 0,  "enabled": true,  "allowed_origins": [    "string"  ],  "admission_limits": {    "customer": {      "environment": {        "requests": 1,        "items": 1,        "body_bytes": 1      },      "customer": {        "requests": 1,        "items": 1,        "body_bytes": 1      },      "session": {        "requests": 1,        "items": 1,        "body_bytes": 1      },      "ip": {        "requests": 1,        "items": 1,        "body_bytes": 1      },      "event_name": {        "items": 1      }    },    "exchange": {      "environment": {        "requests": 1      },      "ip": {        "requests": 1      }    },    "anonymous_exchange": {      "ip": {        "requests": 1      }    },    "stream": {      "environment": {        "requests": 1,        "body_bytes": 1      },      "customer": {        "requests": 1,        "body_bytes": 1      },      "session": {        "requests": 1,        "body_bytes": 1      },      "ip": {        "requests": 1,        "body_bytes": 1      }    },    "backend_exchange": {      "environment": {        "requests": 1      }    }  },  "customer_grant_policy": [    "customer:read"  ],  "created_at": "string",  "updated_at": "string"}

Configure client origins and lower admission limits

PATCH
/client_configuration

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length
If-Match*string

Required revision, checked in the owning transaction.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/client_configuration" \  -H "Idempotency-Key: string" \  -H "If-Match: string" \  -H "Content-Type: application/json" \  -d '{    "allowed_origins": [      "https://app.example"    ]  }'
{  "environment_id": "string",  "version": 0,  "enabled": true,  "allowed_origins": [    "string"  ],  "admission_limits": {    "customer": {      "environment": {        "requests": 1,        "items": 1,        "body_bytes": 1      },      "customer": {        "requests": 1,        "items": 1,        "body_bytes": 1      },      "session": {        "requests": 1,        "items": 1,        "body_bytes": 1      },      "ip": {        "requests": 1,        "items": 1,        "body_bytes": 1      },      "event_name": {        "items": 1      }    },    "exchange": {      "environment": {        "requests": 1      },      "ip": {        "requests": 1      }    },    "anonymous_exchange": {      "ip": {        "requests": 1      }    },    "stream": {      "environment": {        "requests": 1,        "body_bytes": 1      },      "customer": {        "requests": 1,        "body_bytes": 1      },      "session": {        "requests": 1,        "body_bytes": 1      },      "ip": {        "requests": 1,        "body_bytes": 1      }    },    "backend_exchange": {      "environment": {        "requests": 1      }    }  },  "customer_grant_policy": [    "customer:read"  ],  "created_at": "string",  "updated_at": "string"}

Change_sets

Configuration proposals: applied under the environment autonomy policy, or confirmed by a person in the dashboard; logged and undoable.

Config

Whole-environment export and atomic apply.