Get active membership for a dynamic group

get

https://{tenanturl}/v1.0/dynamicgroups/{id}/members

Retrieves all the active membership for a dynamic group where the dynamic group's state is one of the following: active, active_waiting, active_inprogress, active_reviewpublish, or active_failed.

Entitlement required: tenantAdmin, manageDynamicGroups, readDynamicGroups
Note: You only need one entitlement, but you can have more than one.

Path Params

string

required

Id of the dynamic group

Query Params

details

string

enum

Defaults to false

If details is set to true, it provides additional information about the user who is active member of the dynamic group, user who created or last modified the dynamic group.

Allowed:

attributes

string

Filter the result based on attributes. Supported attributes: user, userType.

For example: search=user,userType (The response is filtered to include only user and userType.)

countMembers

string

enum

Defaults to true

If countMembers is set to true, the total number of active members in the dynamic group is calculated.

Allowed:

limit

string

Defaults to 25

The maximum number of resources for a page. By default, up to 25 resources are returned per page if the limit query parameter is not specified. The maximum allowable value for the limit parameter is 500.

For example, if the limit parameter is set to 5, then, 5 resources are fetched for a page.

page

string

Defaults to 1

Page number used to get resources for specific page. Resources are returned for first page if no page query parameter is passed or less than 1 is passed.

For example, if the page parameter is set to 2, then, the resources are fetched for second page.

Responses

Language

URL

Response

Choose an example:

application/json

200Fetched all the active membership of the given dynamic group.

400Bad Request

401Unauthorized

404Not Found

500Internal Server Error