Sign in
clients

find security server clients

Changed on
<h3>Administrator views the clients of the security server.</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

namestring text

pass an optional search string (name) for looking up clients

instancestring text

pass an optional search string (instance) for looking up clients

member_classstring text

pass an optional search string (member_class) for looking up clients

member_codestring text

pass an optional search string (member_code) for looking up clients

subsystem_codestring text

pass an optional search string (subsystem_code) for looking up clients

show_membersboolean

to include members for search results

internal_searchboolean

to search only clients inside security server

local_valid_sign_certboolean

To search only clients that have (or don't have) a valid (registered, OCSP response GOOD) sign cert stored on this security server. Can be used to search both local and global clients, and can be combined with <code>internal_search</code> and <code>exclude_local</code> parameters. True = limit to clients that have a valid local sign cert, false = limit to clients that don't have a valid local sign cert.

exclude_localboolean

to search only clients that are not added to this security server

include_management_service_checkboolean

add info, is this subsystem management service provider or not

Response

list of clients

idstring text

<instance_id>:<member_class>:<member_code>:<subsystem>(optional). Cannot contain colons, semicolons, slashes, backslashes, percent signs or control characters

instance_idstring text

Xroad instance id. Cannot contain colons, semicolons, slashes, backslashes, percent signs or control characters

member_namestring text

Member name. Cannot contain colons, semicolons, slashes, backslashes, percent signs or control characters

member_classstring text required

Member class. Cannot contain colons, semicolons, slashes, backslashes, percent signs or control characters

member_codestring text required

Member code. Cannot contain colons, semicolons, slashes, backslashes, percent signs or control characters

subsystem_codestring text

Subsystem code. Cannot contain colons, semicolons, slashes, backslashes, percent signs or control characters

subsystem_namestring text

Subsystem name. Cannot contain colons, semicolons, slashes, backslashes, percent signs or control characters

ownerboolean

if this client is the owner member of this security server

has_valid_local_sign_certboolean

if this client has a valid (registered and with good OCSP response) sign cert stored on this security server

is_management_services_providerboolean

if this client is management services provider

rename_status'NAME_SET' | 'NAME_SUBMITTED' enum

rename status

connection_type'HTTP' | 'HTTPS' | 'HTTPS_NO_AUTH' enum

connection type

status'REGISTERED' | 'SAVED' | 'GLOBAL_ERROR' | 'REGISTRATION_IN_PROGRESS' | 'DELETION_IN_PROGRESS' | 'DISABLED' | 'DISABLING_IN_PROGRESS' | 'ENABLING_IN_PROGRESS' enum

client status

Example response

[
  {
    "id": "FI:GOV:123:ABC",
    "instance_id": "FI",
    "member_name": "FI",
    "member_class": "GOV",
    "subsystem_code": "ABC",
    "subsystem_name": "FI",
    "rename_status": "NAME_SET",
    "connection_type": "HTTP",
    "status": "REGISTERED"
  }
]

Changes