Sign in
global-groups

find global group members

Changed on
<h3>CS administrator view of global group members.</h3>
post/global-groups/{group_code}/members

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/global-groups/{group_code}/members
  • Auth: API key in header Authorization

Path parameters

group_codestring text required

group code

Request body

querystring nullable

free text query

member_classstring nullable

member class

instancestring nullable

X-Road instance

codesstring[] nullable

member code

subsystemsstring[] nullable

subsystem code

typesClientType[] nullable

client type

Example request

{
  "types": [
    "SUBSYSTEM"
  ],
  "paging_sorting": {
    "sort": "title"
  }
}

Response

paged array of global group members

Example response

{
  "items": [
    {
      "created_at": "2022-01-20T00:00:00.001Z",
      "id": 123,
      "client_id": {
        "instance_id": "FI",
        "member_class": "GOV",
        "subsystem_code": "ABC"
      }
    }
  ]
}

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