Skip to main content
GET
/
api
/
adm
/
identityServerClients
Get IdentityServer Clients
curl --request GET \
  --url https://localhost:44371/api/adm/identityServerClients \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": []
}

​
Description

Returns a list of OAuth 2.0 and OpenID Connect clients configured in IdentityServer4. Results can be filtered by client ID, name, or other criteria. Used for managing authentication applications and services.

​
Input

  • Query Parameters: model (IdentityServerClientQueryRequest) — Filtering options including:
    • id (guid, optional) — Filter by specific client identifier.
    • clientId (string, optional) — Filter by OAuth client ID.
    • clientName (string, optional) — Filter by client name (partial match).
    • enabled (bool, optional) — Filter by enabled status.

​
Output

Returns a IdentityServerClientQueryResponse containing matching clients or an empty list if none found.

​
Example Request

GET /api/admin/identityServerClients?id=3fa85f64-5717-4562-b3fc-2c963f66afa6
Authorization: Bearer {token}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "clientId": "adminui.client",
      "clientName": "Admin UI Application",
      "allowedScopes": ["AdminUI", "openid", "profile"],
      "enabled": true
    }
  ]
}

​
Errors

  • 400 Bad Request — Invalid query parameters or filter values.
  • 401 Unauthorized — Missing or invalid authentication token.

​
Notes

  • Results include sensitive configuration data; access restricted to administrators.
  • Client secrets are masked in query results for security.
  • Empty results return success with an empty entries array.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
CompanyId
string<guid> | null

The optional identifier of the company to filter by.

​
CompanyProjectId
string<guid> | null

The optional identifier of the project to filter by.

​
Id
string<guid> | null

Optional identifier to filter results by a specific entity.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

Returns the matching IdentityServer client entries (may be an empty list if no matches found).

Standard response structure containing operation status and error information. Standard query response containing a collection of matching entities. Represents the response returned when querying identity server clients.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null

​
entries
object[] | null

Collection of entities matching the query criteria.

Example:
[]