Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Group Membership Expiration Policy

GET/api/v2/admin/groups/{groupId}/membershipExpirationPolicy
Warning

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.

Get the GroupMembershipExpirationPolicy.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-read.

Path parameters

groupId
string

The ID of a Foundry Group or User.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Response body

GroupMembershipExpirationPolicy
object
Hide child attributes

Hide child attributes

maximumValue
string
optional

Members in this group must be added with expiration times that occur before this value.

maximumDuration
string
optional

Members 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.

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/groups/f05f8da4-b84c-4fca-9c77-8af0b13d11de/membershipExpirationPolicy?preview=true"

Response

Copied!
1 2 3 4 { "maximumDuration": 30, "maximumValue": "2026-01-31T00:00:00.000Z" }

Error responses

Error Name
GroupMembershipExpirationPolicyNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given GroupMembershipExpirationPolicy could not be found.
ParametersgroupId
GroupNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Group could not be found.
ParametersgroupId