GET /clients/home-realm – Retrieves details of a specific client application by its home realm.


Headers:

  • No Authorization header required
  • Content-Type: application/json or application/x-www-form-urlencoded (required)

Body:

  • None

Path Parameters:

  • None Query Parameters:
  • provider: The authentication provider (optional). Defaults to auth0-client if omitted. See ClientProvider.
  • product: The product identifier associated with the client (required). See ProductKey.
  • subdomain: The subdomain associated with the client (required).

  • 200 OK – Returns the 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"
}

GET /clients/home-realm?product=exampleProduct&subdomain=exampleSubdomain
GET /clients/home-realm?product=exampleProduct&subdomain=exampleSubdomain&provider=cognito-client
	{
"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"
// 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.