Skip to content

MembershipsApi.md

Latest commit

 

History

History
130 lines (67 loc) · 4.05 KB

MembershipsApi.md

File metadata and controls

130 lines (67 loc) · 4.05 KB

\MembershipsApi

All URIs are relative to http://localhost

Method HTTP request Description
memberships_get_organization_memberships GET /api/public/organizations/memberships
memberships_get_project_memberships GET /api/public/projects/{projectId}/memberships
memberships_update_organization_membership PUT /api/public/organizations/memberships
memberships_update_project_membership PUT /api/public/projects/{projectId}/memberships

memberships_get_organization_memberships

models::MembershipsResponse memberships_get_organization_memberships()

Get all memberships for the organization associated with the API key (requires organization-scoped API key)

Parameters

This endpoint does not need any parameter.

Return type

models::MembershipsResponse

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

memberships_get_project_memberships

models::MembershipsResponse memberships_get_project_memberships(project_id)

Get all memberships for a specific project (requires organization-scoped API key)

Parameters

Name Type Description Required Notes
project_id String [required]

Return type

models::MembershipsResponse

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

memberships_update_organization_membership

models::MembershipResponse memberships_update_organization_membership(membership_request)

Create or update a membership for the organization associated with the API key (requires organization-scoped API key)

Parameters

Name Type Description Required Notes
membership_request MembershipRequest [required]

Return type

models::MembershipResponse

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

memberships_update_project_membership

models::MembershipResponse memberships_update_project_membership(project_id, membership_request)

Create or update a membership for a specific project (requires organization-scoped API key). The user must already be a member of the organization.

Parameters

Name Type Description Required Notes
project_id String [required]
membership_request MembershipRequest [required]

Return type

models::MembershipResponse

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]