GET /clients/home-realm – Retrieves details of a specific client application by its home realm.
Headers:
Authorization
Content-Type: application/json or application/x-www-form-urlencoded
Body:
Path Parameters:
auth0-client
200 OK
400
401
404
500
{ "error": "Detailed error message here"} Copy
{ "error": "Detailed error message here"}
GET /clients/home-realm?product=exampleProduct&subdomain=exampleSubdomain Copy
GET /clients/home-realm?product=exampleProduct&subdomain=exampleSubdomain
GET /clients/home-realm?product=exampleProduct&subdomain=exampleSubdomain&provider=cognito-client Copy
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 } Copy
{ "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 }
The API Gateway event containing the request.
A Promise resolving to an API Gateway-compatible response.
GET /clients/home-realm – Retrieves details of a specific client application by its home realm.
📥 Request
Headers:
Authorizationheader requiredContent-Type: application/json or application/x-www-form-urlencoded(required)Body:
Path Parameters:
auth0-clientif omitted. See ClientProvider.📤 Response
200 OK– Returns the client Client.❗ Errors
400401404500Error Response Format
📦 Examples
📥 Auth0 Request
📥 Cognito Request
📤 Response Example