Skip to content

User Groups

The Group Management API adheres to the SCIM 2.0 protocol unless otherwise stated, and provides management and provisioning of Groups and its members (Users) within a Program. Managing Groups requires that the acting User have a role of Program Manager or Administrator, and Group read and/or write access.

User groups are SCIM groups only. Currently, this API does not support creating audiences .

Operations

Returns a list of Groups

Request

Returns a list of all accessible Groups in the acting User's Program.

Security
oauth2_as_a_server(Required scopes: groups.read) or oauth2_as_a_user(Required scopes: groups.read)
Query
startIndexinteger

Specifies the 1-based index of the page of results to be returned.

countinteger

Specifies the maximum number of results to be returned.

curl -i -X GET \
  'https://partner.socialchorus.com/scim/v2/Groups?startIndex=0&count=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/scim+json
schemasArray of strings
Example:
[
  "urn:ietf:params:scim:api:messages:2.0:ListResponse"
]
ResourcesArray of objects(Scim.Group.Resource)
Response
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    { … }
  ]
}