Sign in
clients

Add new client for the security server.

Changed on
<h3>Adds new client to the system.</h3> <p>The client id will be validated and if the validation fails a validation error is returned. Note that with this endpoint it is possible to add an unregistered member as a client. <ul> <li>Attempt to add an unregistered member with <code>ClientAdd.ignore_warnings</code> = false causes the operation to fail with a warning in response's ErrorInfo object.</li> <li>Attempt to add an unregistered member with <code>ClientAdd.ignore_warnings</code> = true succeeds.</li> </ul> </p> <p>When trying to add an unregister client, the error response has an error code <code>unregistered_member</code> and the metadata field contains the identifier of the unregistered client</p>
post/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

Request body

ignore_warningsboolean

if true, any ignorable warnings are ignored. if false (or missing), any warnings cause request to fail

Example request

{
  "client": {
    "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"
  }
}

Response

new client created

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

  • 46b8a2b85de9Revision changes
    • ○

      added the optional property to the response with the status

  • 857d124e3303Revision changes
    • ●

      removed the optional property from the response with the status

    • ○

      added the optional property to the response with the status