Skip to content
/
Updates a Group

Updates a Group

Request

Updates and provisions an existing Group of Users. The request should include any properties to be set on the Group. Any property not provided would leave the value blank or use defaults.

The list of members could be empty or not present. Members are referenced with the identifierField, by either:

  • email
  • id
  • userName (the default if no identifierField is included)

This operation is asynchronous, the response will not include the list of members.

A JobId will be in the response's meta, to be able to get a JobReport ( GET /v2/Groups/JobReport/{jobId}).

Indexing a Group's Users can take some time.

Security
oauth2_as_a_server(Required scopes: groups.write) or oauth2_as_a_user(Required scopes: groups.write)
Path
group_idstringrequired

ID of the audience to update

Bodyapplication/json
displayNamestringrequired
Example:"Group of specific users"
descriptionstring
Example:"Group of iOS users from partner domain"
SocialChorus:1.0:Groupobject(Scim.Group.SocialChorusExtension)
externalIdstring
Example:"1234qweasd567"
membersArray of objects

An array of objects representing user identifiers to be included into a group. The identifiers allowed are the user "id", "email" and "userName" (defaulting to "userName").

Example:
[
  {
    "value": "username3"
  },
  {
    "value": "username4"
  },
  {
    "value": "username33"
  }
]
curl -i -X PUT \
  'https://partner.socialchorus.com/scim/v2/Groups/{group_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "Group of specific users",
    "description": "Group of iOS users from partner domain",
    "SocialChorus:1.0:Group": {
      "identifierField": "userName"
    },
    "externalId": "1234qweasd567",
    "members": [
      {
        "value": "username3"
      },
      {
        "value": "username4"
      },
      {
        "value": "username33"
      }
    ]
  }'

Responses

Group updated

Bodyapplication/scim+json
schemasArray of strings

List of Schemas

Example:
[
  "urn:ietf:params:scim:schemas:core:2.0:Group",
  "SocialChorus:1.0:Group"
]
idinteger

Group unique id

Example:115
namestring

A name for the Group, generated from the given displayName.

Example:"group_of_users"
displayNamestring

A human-readable name for the Group.

Example:"Group of users"
externalIdstring

ID from provisioning system. This is the resource ID on the client system, not Firstup's ID.

Example:"1234qweasd567"
descriptionstring

Description for the Group.

Example:"Group of iOS users from partner domain"
membersArray of objects

An empty array, as members will be changed later, asynchronously

Example:
[]
metaobject
SocialChorus:1.0:Groupobject
Example:
{}
Response
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group",
    "SocialChorus:1.0:Group"
  ],
  "id": 115,
  "name": "group_of_users",
  "displayName": "Group of users",
  "externalId": "1234qweasd567",
  "description": "Group of iOS users from partner domain",
  "members": [],
  "meta": {
    "resourceType": "Group",
    "created": "2022-05-13T13:32:00.598Z",
    "lastModified": "2022-05-13T13:32:00.598Z",
    "location": "https://partner.socialchorus.com/scim/v2/Groups/115",
    "jobId": 4567
  },
  "SocialChorus:1.0:Group": {}
}