Groups - Get Group Members | Webex for Developers

Get Group Members

Returns the members of a group.

The default maximum number of members returned is 500.
Control parameters are available to page through the members and to control the size of the results.
Long result sets are split into pages.

Note Location groups are different from SCIM groups. You cannot search for identities in a location via groups.

Authorization

OAuth token returned by the Identity Broker.

One of the following OAuth scopes is required:

identity:people_rw
identity:people_read

The following administrators can use this API:

id_full_admin
id_group_admin
id_readonly_admin
id_device_admin

GET/identity/scim/{orgId}/v2/Groups/{groupId}/Members

URI Parameters

orgId

stringrequired

The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.

groupId

stringrequired

A unique identifier for the group.

Query Parameters

startIndex

number

The index to start for group pagination.

count

number

Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.

memberType

string

Filter the members by member type. Sample data: user, machine, group.

Response Properties

schemas

array[string]

Input JSON schemas.

displayName

string

A human-readable name for the group.

totalResults

number

Total number of groups in search results.

itemsPerPage

number

The total number of items in a paged result.

startIndex

number

Start at the one-based offset in the list of matching groups.

members

array[object]

A list of members of this group.

type

string

A label indicating the type of resource, for example user, machine, or group.

Possible values: user

value

string

The identifier of the member of this Group.

Possible values: c5349664-9f3d-410b-8bd3-6c31f181f13d

display

string

A human-readable name for the group member.

Possible values: A user

Response Codes

The list below describes the common success and error responses you should expect from the API:

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The requested resource is temporarily unavailable. A `Retry-After` header may be present that specifies how many seconds you need to wait before attempting the request again.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	Too Many Requests	Too many requests have been sent in a given amount of time and the request has been rate limited. A `Retry-After` header should be present that specifies how many seconds you need to wait before a successful request can be made.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

GET

/identity/scim//v2/Groups//Members{?startIndex,count,memberType}

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

startIndex
number
The index to start for group pagination.
count
number
Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500.
memberType
string
Filter the members by member type. Sample data: `user`, `machine`, `group`.

https://webexapis.com/identity/scim/e9f9ab27-0459-4cd0-bd72-089bde5a7da6/v2/Groups/cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3/Members?startIndex=1&count=100&memberType=user

200 / OK

{
    "schemas": [
        "urn:scim:schemas:extension:cisco:webexidentity:2.0:GroupMembers"
    ],
    "memberSize": 2,
    "displayName": "group_name",
    "itemsPerPage": 2,
    "startIndex": 1,
    "members": [
        {
            "value": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
            "type": "user",
            "display": "A user"
        },
        {
            "value": "ffd2164c-b938-46dd-8b2f-def6c33b45d0",
            "type": "group",
            "display": "A nested group"
        }
    ]
}