Sign in
clients

find ServiceClient candidates for a specific client

<h3>Administrator views the clients, globalgroups and localgroups, that could be added as ServiceClients for given Client's services.</h3>
get/clients/{id}/service-client-candidates

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/{id}/service-client-candidates
  • Auth: API key in header Authorization

Path parameters

idstring text required

id of the client

Query parameters

member_name_group_descriptionstring text

pass an optional search string (name) for looking up subjects - name of a member or description of a group

service_client_type'GLOBALGROUP' | 'LOCALGROUP' | 'SUBSYSTEM' text

subject type

Example:GLOBALGROUP

pass an optional search string (service_client_type) for looking up service clients

instancestring text

pass an optional search string (instance) for looking up service clients - full instance id should be used

member_classstring text

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

member_group_codestring text

pass an optional search string (member_group_code) for looking up service clients - member_code of a member or group_code of a group

subsystem_codestring text

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

Response

list of service clients

idstring text required

subject id - can be a subsystem id <instance_id>:<member_class>:<member_code>:<subsystem> | globalgroup id <instance_id>:<group_code> | localgroup resource id in number format <id>

namestring text

name of the ServiceClient - can be the name of a member or the description of a group

local_group_codestring text

group code in case the object is a local group

service_client_type'GLOBALGROUP' | 'LOCALGROUP' | 'SUBSYSTEM' text

subject type

rights_given_atstring date-time

time when access right were given at. When listing client's service clients without specifying the service, the time when first service access right was given to this service client for any service. When listing service clients for a specific service, time when service client was added permission to that service.

Example response

[
  {
    "id": "DEV:ORG:1234:Subsystem | DEV:security-server-owners | 123",
    "name": "Security server owners",
    "local_group_code": "My own Local group code",
    "service_client_type": "GLOBALGROUP",
    "rights_given_at": "2018-12-15T00:00:00.001Z"
  }
]

Changes

No recorded changes to this operation across all 50 revisions of this API.