Sign in
clients

find clients

Changed on
<h3>CS administrator searches for X-Road clients.</h3>
get/clients

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/clients
  • Auth: API key in header Authorization

Query parameters

qstring text
Example:foobar

An optional generic filtering query parameter selects only items that contain parameter value in properties (member name, member_class, member_code, subsystem_code) . Needs to be properly encoded for the special characters, too. Empty value means the parameter is ignored.

sortstring

Indicates item property that is to be used as sorting key.

descboolean

Used sorting direction. Value 'true' indicates descending and 'false' or omitted parameter indicates ascending direction.

limitinteger

Indicates the maximum number of items for the returned page. If parameter is omitted, then the default amount of 25 is returned.

offsetinteger

Offset in pages from the beginning of the query result after filtering and sorting parameters are taken into account. If the parameter omitted or the value 0 (zero) is given, the first page is returned.

optional paging and sorting parameters. Sorting possible according to one of the following values: <ul> <li><b>id</b> for id</li> <li><b>member_name</b> for client's member name,</li> <li><b>xroad_id.instance_id</b> for client's instance id</li> <li><b>xroad_id.member_class</b> for client's member class or</li> <li><b>xroad_id.member_code</b> for client's member code or</li> <li><b>client_type</b> for client type.</li>

</ul>
{
  "sort": "title"
}
namestring text

an optional search string (member name). Client field needs to contain parameter value (case insensitive). Empty value means the parameter is ignored.

instancestring text

an optional search string (instance). Client field needs to contain parameter value (case insensitive). Empty value means the parameter is ignored.

member_classstring text

an optional search string (member_class). Client field needs to contain parameter value (case insensitive). Empty value means the parameter is ignored.

member_codestring text

an optional search string (member_code). Client field needs to contain parameter value (case insensitive). Empty value means the parameter is ignored.

subsystem_codestring text

an optional search string (subsystem_code). Client field needs to contain parameter value (case insensitive). Empty value means the parameter is ignored.

client_type'MEMBER' | 'SUBSYSTEM' text

client type

Example:SUBSYSTEM

an optional parameter limiting search to either members or subsystems. If not used, both are searched for.

security_serverstring text

<instance_id>:<member_class>:<member_code>:<security_server_code>

Example:FI:GOV:123:sserver1

an optional security server id parameter - only return clients that belong to this security server. Empty value means the parameter is ignored.

excluding_groupstring text

an optional global group code parameter - only return clients that do not belong to this group. Empty value means the parameter is ignored.

Response

paged clients results

Example response

{
  "clients": [
    {
      "member_name": "Member123"
    }
  ]
}

Changes

  • 72c3c9c00de3Revision changes
    • ○

      mapped value for discriminator key MEMBER changed from ClientId to for ////// response property for the response status

    • ○

      mapped value for discriminator key SERVER changed from SecurityServerId to for ////// response property for the response status

    • ○

      mapped value for discriminator key SUBSYSTEM changed from ClientId to for ////// response property for the response status

  • 49854d95889cRevision changes
    • ▲

      the /////// response's property format changed from text§ to text for status