verifyActiveMembership (v1)

Verify active membership

Overview

Verifies whether the provided member has an active membership within any team of the organisation.

POST (/internal/v1/parties/{organisationPartyId}/teams:verify-active-membership)

Parameters

  • organisationPartyId (path) (required): The unique identifier of the organisation party.
  • X-Request-ID (header): Request ID used for tracing. A new one will be generated if not provided.

Request Body

Responses

200 OK

Result of verifying whether a member has active memberships within an organisation.

400 Bad Request

401 Unauthorized

404 Not Found

500 Internal Server Error

Architecture

1 property

Request body for the verify-active-membership operation.

memberId string
required

Identifier of a team member.

4 properties

Result of verifying whether a member has active memberships within an organisation.

userId string

The unique identifier of the user linked to the member.

activeTeams array [object]
7 properties
code string
Allowed values: urn:plmr:teams:api:BAD_REQUEST urn:plmr:teams:api:INVALID_PARAM urn:plmr:teams:api:WEB_APPLICATION
message string
requestId string
fieldErrors array [object]
3 properties
code string
Allowed values: urn:plmr:teams:api:UNAUTHORIZED
message string
requestId string
3 properties
code string
Allowed values: urn:plmr:teams:api:RESOURCE_UNKNOWN urn:plmr:teams:api:MEMBER_NOT_FOUND
message string
requestId string
3 properties
code string
Allowed values: urn:plmr:teams:api:INTERNAL_SERVER_ERROR
message string
requestId string