PATCH /clients/{clientId} – Updates specific attributes of a client application.


Headers:

  • Authorization: Bearer <access_token> (required)
  • Content-Type: application/json or application/x-www-form-urlencoded (required)

Body:

Path Parameters:

  • clientId: The ID of the client to update (required)

Query Parameters:

  • None

  • 200 OK – Returns the updated client Client.

Status Code Meaning When it Happens
400 Bad Request Missing or invalid fields in request body
401 Unauthorized Missing or invalid authentication token
404 Not Found Specified client does not exist
500 Internal Server Error Unexpected error
{
"error": "Detailed error message here"
}

PATCH /clients/exampleClientId
{
"client": {
"callbacks": ["https://new-callback-url.com"],
"allowedLogoutUrls": ["https://new-logout-url.com"]
}
}
PATCH /clients/exampleClientId
{
"provider": "cognito-client",
"userPoolId": "us-east-1_1234test",
"client": {
"callbacks": ["https://new-callback-url.com"],
"allowedLogoutUrls": ["https://new-logout-url.com"]
}
}
json
{
"id": "clientId",
"name": "string",
"secret": "string",
"callbacks": ["string"],
"allowedLogoutUrls": ["string"],
"grantTypes": ["string"],
"tokenEndpointAuthMethod": "string",
"supportedIdp": ["string"],
"description": "string",
"webOrigins": ["string"],
"appType": "string",
"clientMetadata": { "key": "value" },
"disabled": false,
"oidcConformant": true,
"auth0Id": "string"
"callbacks": ["https://new-callback-url.com"],
"allowedLogoutUrls": ["https://new-logout-url.com"]
// More fields may be present depending on the provider
}

  • Parameters

    • event: APIGatewayProxyEvent

      The API Gateway event containing the request.

    • context: Context
    • callback: Callback<APIGatewayProxyResult>

    Returns void | Promise<APIGatewayProxyResult>

    A Promise resolving to an API Gateway-compatible response.