Sign in
clients

get single service client by client id and service client id

<h3>Administrator views the information for a single service client.<h3>
get/clients/{id}/service-clients/{sc_id}

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-clients/{sc_id}
  • Auth: API key in header Authorization

Path parameters

idstring text required

id of the client

sc_idstring text required

id of the service client

Response

single 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.