Refresh Membership (Group)

URL:
https://<root>/orgs/<orgID>/security/groups/refreshMembership
Methods:
POST
Required Capability:
Access allowed with either the "Links to organization-specific group" or "Security and infrastructure" privileges
Version Introduced:
10.9

Description

The refreshMembership operation iterates over every enterprise account configured in your organization and determines whether the user account is part of the input enterprise group. If there are any changes in membership, the database and indexes are updated for each group. While the organization automatically refreshes the memberships during a user login, and during a periodic refresh configured through the Update Identity Store operation, this operation allows an administrator to force a refresh.

Request parameters

ParameterDetails

groups

A comma-separated list of group names whose memberships need to be refreshed.

Example
Use dark colors for code blocksCopy
1
groups=cartographers,analyst

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the refreshMembership operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /context/admin/orgs/0123456789ABCDEF/security/groups/refreshMembership HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

groups=cartographers,analyst&f=pjson&token=Mb0ORrkLObNO2Q8FZoUCHHzSMzZi0CbhLHNRYMqqa6URG_ojQJF3rNsJAfRB23MyCrLwSmuaHPUo4AEIrUuoH1-4Ot5xh4565FtlQahXAhK2C7Sy0oydZhBwD8KdFSnVlnLr-e9uI5ovSWZ2lGNn9SwoV2MPMzeAh_5r-q-wgwF8DTT_nhuCXJGkMRy-48jjGS2aN5FI18STHZ8RAuKxGasH90SI3C7njZzlGCUrY5m6BDhCMsdpZA14GwNX8Cis

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.