Sign in
global-groups

add new members for the global group

<h3>CS administrator adds an X-Road member or a member's subsystem to a global group.</h3>
post/global-groups/{group_code}/members/add

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/add
  • Auth: API key in header Authorization

Path parameters

group_codestring text required

group code

Request body

itemsstring[]

array of members to be added

Example request

{
  "items": [
    "FI:GOV:123",
    "FI:GOV:123:SS1",
    "FI:GOV:123:SS2"
  ]
}

Response

Response list contains only new members added to group, if request contains member already in group then it will be excluded from response.

itemsstring[]

array of members to be added

Example response

{
  "items": [
    "FI:GOV:123",
    "FI:GOV:123:SS1",
    "FI:GOV:123:SS2"
  ]
}

Changes

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