Add Users to UserGroup

post

https://api.synap.ac/v3https://api-stage.synap.ac/v3

/user-groups/{object_id}/relationships/users

Authorizations

SessionAuthPATAuthLegacySessionAuth

AuthorizationstringRequired

Authorize the request using a Session Token.

Path parameters

object_idstringRequired

The primary key for each resource.

Example: FID001

Body

application/vnd.api+json

Responses

202

Accepted

application/vnd.api+json

204

Success

400

Bad request

application/vnd.api+json

401

Unauthorised

application/vnd.api+json

403

Forbidden

application/vnd.api+json

404

Not found

application/vnd.api+json

post/user-groups/{object_id}/relationships/users

HTTPcURLJavaScriptPython

POST /v3/user-groups/{object_id}/relationships/users HTTP/1.1
Host: api.synap.ac
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 40

{
  "data": [
    {
      "id": "FID001",
      "type": "User"
    }
  ]
}

{
  "data": {
    "id": "FID001",
    "type": "BackgroundJob"
  }
}