Update a dynamically registered client's configuration
RFC 7592 client update, authenticated with the registration access token as a Bearer token.
PUT/api/v1/auth/oauth2/register/clientId
- Sign-in
- None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
- Rate limit
- Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 30 requests a minute per IP address.
RFC 7592 client update, authenticated with the registration access token as a Bearer token. Only redirect_uris and client_name change, and an omitted client_name resets to the server default; a changed client_id or client_secret answers 400. Rotates the registration access token and records the before and after in the audit log.
Request
Path parameters
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
clientId | string | Yes | - | - |
Send the body as application/json or application/x-www-form-urlencoded. The body is optional.
Body
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
client_id | string or null | No | at most 256 characters | - |
client_secret | string or null | No | at most 1024 characters | - |
redirect_uris | array of string or null | No | at most 100 items | - |
client_name | string or null | No | at most 1000 characters | - |
Example request
Replace each YOUR_... value with your own.
curl -X PUT "https://api.console.buildbase.app/api/v1/auth/oauth2/register/YOUR_CLIENT_ID" \
-H "Content-Type: application/json" \
-d '{
"client_id": "YOUR_CLIENT_ID",
"client_secret": "string",
"redirect_uris": [
"string"
]
}'const response = await fetch(
'https://api.console.buildbase.app/api/v1/auth/oauth2/register/YOUR_CLIENT_ID',
{
method: 'PUT',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
client_id: 'YOUR_CLIENT_ID',
client_secret: 'string',
redirect_uris: ['string'],
}),
}
);
if (!response.ok) {
throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();import requests
response = requests.put(
"https://api.console.buildbase.app/api/v1/auth/oauth2/register/YOUR_CLIENT_ID",
json={
"client_id": "YOUR_CLIENT_ID",
"client_secret": "string",
"redirect_uris": [
"string",
],
},
timeout=30,
)
response.raise_for_status()
data = response.json()Responses
200 OK
OK
{
"client_id": "Onk5TwQjhFIJ86vH7qEcuP4F1iVC6lZRUFz6brd1",
"client_name": "E2E Dynamic Agent v2",
"client_secret": "[REDACTED]",
"client_secret_expires_at": 0,
"grant_types": ["authorization_code", "refresh_token"],
"redirect_uris": [
"http://127.0.0.1:9975/callback",
"http://127.0.0.1:9976/callback"
],
"registration_access_token": "[REDACTED]",
"registration_client_uri": "http://localhost:3000/api/v1/auth/oauth2/register/Onk5TwQjhFIJ86vH7qEcuP4F1iVC6lZRUFz6brd1?org=000000000000000000000001",
"response_types": ["code"],
"scope": "",
"token_endpoint_auth_method": "[REDACTED]"
}Any other status
Any other answer the handler sends itself (its own refusals). Not described yet.
Errors
Each refusal, what it means, and what to do. The request changed nothing.
400 Bad Request
What it means: The request failed a validate() schema, or an id in the path is not a valid id. path names the field.
What to do: Fix the field the body names in path (or read message) and send the request again. Nothing was changed.
{
"error": true,
"success": false,
"path": "string",
"message": "string"
}429 Too Many Requests
What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.
What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.
{
"success": false,
"message": "string",
"reason": "rate_limited",
"retryAfter": 1
}Related
- OAuth 2.0 guide: how this part of BuildBase works
- All OAuth 2.0 operations
- API reference: every operation, by tag
- Sign-in and credentials for the HTTP API
- How the HTTP API reports errors
- Make your first call
- Error codes: every
codethe API returns - OpenAPI: operation
oauth2.register.updatein public-v1.json