This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Replace the GroupMembershipExpirationPolicy.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-write.
objectstringMembers in this group must be added with expirations that are less than this duration in seconds into the future from the time they are added.
stringMembers in this group must be added with expiration times that occur before this value.
objectThe replaced GroupMembershipExpirationPolicy
stringMembers in this group must be added with expiration times that occur before this value.
stringMembers in this group must be added with expirations that are less than this duration in seconds into the future from the time they are added.
1
2
3
4
5
curl -X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/admin/groups/f05f8da4-b84c-4fca-9c77-8af0b13d11de/membershipExpirationPolicy?preview=true" \
-d '{"maximumDuration":30,"maximumValue":"2026-01-31T00:00:00.000Z"}'1
2
3
4
{
"maximumDuration": 30,
"maximumValue": "2026-01-31T00:00:00.000Z"
}| Error Name | ||
|---|---|---|
Replace | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not replace the GroupMembershipExpirationPolicy. | |
| Parameters | groupId | |
Group | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Group could not be found. | |
| Parameters | groupId | |
See Errors for a general overview of errors in the platform.