ArchAstro.V1.TeamMemberships (archastro v0.2.0)

Copy Markdown

TeamMembership API resource.

Summary

Functions

delete(client, team_membership)

@spec delete(ArchAstro.Client.t(), String.t()) ::
  {:ok, :ok} | {:error, ArchAstro.Error.reason()}

Remove a team membership by ID

Removes a team membership identified directly by its membership ID. On success, returns 204 No Content.

This endpoint is intended for server-to-server callers that already hold the membership ID. To remove a member by user or agent ID instead, use the team members delete endpoint. The caller must have permission to manage the team that the membership belongs to.

Empty response. Returns 204 No Content on success.

list(client, params \\ %ArchAstro.Types.Operations.GetApiV1TeamMemberships.Params{})

List team memberships

Returns a paginated list of team memberships across all teams accessible to the authenticated caller. Use the team, user, and agent filters to narrow results to a specific team or principal.

This endpoint requires S2S (service-to-service) authentication. Callers authenticated with a user token receive a 401. Each membership includes the resolved type ("user", "agent", or "unknown"), display name, and profile picture derived from the associated user or agent at request time.

Results are returned in offset-based pages. Pass page and page_size to navigate; the response includes has_next and has_prev to determine whether adjacent pages exist.

Paginated list of team memberships matching the applied filters.