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

A Foundry Group ID.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Response body

GroupMembershipExpirationPolicy

object

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!

curl \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/admin/groups/0d1fe74e-2b70-4a93-9b1a-80070637788b/membershipExpirationPolicy?preview=true"

Response

Copied!

{
  "maximumDuration": 30,
  "maximumValue": "2026-01-31T00:00:00.000Z"
}

Error responses

Error Name
`GroupMembershipExpirationPolicyNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given GroupMembershipExpirationPolicy could not be found.
	Parameters	`groupId`
`GroupNotFound`	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.