_Docs/
Get StartedModulesPlatformDeployCookbookChangelogReference
_Reference
  • Membership API
  • Stack API Reference
  1. Membership API
Reference

Membership API

The Membership API manages your Formance Cloud resources: organizations, stacks, users, invitations, regions, and access policies.

locked by Control Plane@latest

membership93

GET
/api/membership/_infoGet server info
GET
/api/membership/.well-known/scopesList all available protected scopes

Applications17

GET
/api/membership/organizations/{organizationId}/applicationsList applications enabled for organization
GET
/api/membership/organizations/{organizationId}/applications/{applicationId}Get application for organization
PUT
/api/membership/organizations/{organizationId}/applications/{applicationId}Enable application for organization
DELETE
/api/membership/organizations/{organizationId}/applications/{applicationId}Disable application for organization
GET
/api/membership/applicationsList applications
POST
/api/membership/applicationsCreate application
GET
/api/membership/applications/{applicationId}Get application
PUT
/api/membership/applications/{applicationId}Update application
DELETE
/api/membership/applications/{applicationId}Delete application
POST
/api/membership/applications/{applicationId}/scopesCreate application scope
DELETE
/api/membership/applications/{applicationId}/scopes/{scopeID}Delete application scope
POST
/api/membership/applications/{applicationId}/scopes/{scopeID}/delegations/{delegatesToScopeId}Add delegation to scope
DELETE
/api/membership/applications/{applicationId}/scopes/{scopeID}/delegations/{delegatesToScopeId}Remove delegation from scope
POST
/api/membership/applications/{applicationId}/clientsCreate application client
GET
/api/membership/applications/{applicationId}/clients/{clientId}Get application client
PUT
/api/membership/applications/{applicationId}/clients/{clientId}Update application client
DELETE
/api/membership/applications/{applicationId}/clients/{clientId}Delete application client

Audit Logs1

GET
/api/membership/organizations/{organizationId}/logsList logs

Clients5

GET
/api/membership/organizations/{organizationId}/clientsRead organization clients
POST
/api/membership/organizations/{organizationId}/clientsCreate organization client
GET
/api/membership/organizations/{organizationId}/clients/{clientId}Read organization client
DELETE
/api/membership/organizations/{organizationId}/clients/{clientId}Delete organization client
PUT
/api/membership/organizations/{organizationId}/clients/{clientId}Update organization client

Current User4

GET
/api/membership/organizations/{organizationId}/groups/{groupId}/membersList group members
PUT
/api/membership/organizations/{organizationId}/groups/{groupId}/members/{userId}Add member to group
DELETE
/api/membership/organizations/{organizationId}/groups/{groupId}/members/{userId}Remove member from group
GET
/api/membership/meRead user

Features3

GET
/api/membership/organizations/{organizationId}/featuresList features
POST
/api/membership/organizations/{organizationId}/featuresAdd Features
DELETE
/api/membership/organizations/{organizationId}/features/{name}Delete feature

Invitations6

GET
/api/membership/me/invitationsList invitations of the user
POST
/api/membership/me/invitations/{invitationId}/acceptAccept invitation
POST
/api/membership/me/invitations/{invitationId}/rejectDecline invitation
GET
/api/membership/organizations/{organizationId}/invitationsList invitations of the organization
POST
/api/membership/organizations/{organizationId}/invitationsCreate invitation
DELETE
/api/membership/organizations/{organizationId}/invitations/{invitationId}Delete invitation

Organizations14

GET
/api/membership/organizationsList organizations of the connected user
POST
/api/membership/organizationsCreate organization
GET
/api/membership/organizations/expandedList organizations of the connected user with expanded data
GET
/api/membership/organizations/{organizationId}Read organization
PUT
/api/membership/organizations/{organizationId}Update organization
DELETE
/api/membership/organizations/{organizationId}Delete organization
GET
/api/membership/organizations/{organizationId}/clientRead organization client (DEPRECATED) (until 12/31/2025)
PUT
/api/membership/organizations/{organizationId}/clientCreate organization client (DEPRECATED) (until 12/31/2025)
DELETE
/api/membership/organizations/{organizationId}/clientDelete organization client (DEPRECATED) (until 12/31/2025)
GET
/api/membership/organizations/{organizationId}/groupsList groups of organization
POST
/api/membership/organizations/{organizationId}/groupsCreate group
GET
/api/membership/organizations/{organizationId}/groups/{groupId}Read group
PUT
/api/membership/organizations/{organizationId}/groups/{groupId}Update group
DELETE
/api/membership/organizations/{organizationId}/groups/{groupId}Delete group

Policies7

GET
/api/membership/organizations/{organizationId}/policiesList policies of organization
POST
/api/membership/organizations/{organizationId}/policiesCreate policy
GET
/api/membership/organizations/{organizationId}/policies/{policyId}Read policy with scopes
PUT
/api/membership/organizations/{organizationId}/policies/{policyId}Update policy
DELETE
/api/membership/organizations/{organizationId}/policies/{policyId}Delete policy
PUT
/api/membership/organizations/{organizationId}/policies/{policyId}/scopes/{scopeId}Add scope to policy
DELETE
/api/membership/organizations/{organizationId}/policies/{policyId}/scopes/{scopeId}Remove scope from policy

Regions5

GET
/api/membership/organizations/{organizationId}/regionsList regions
POST
/api/membership/organizations/{organizationId}/regionsCreate a private region
GET
/api/membership/organizations/{organizationId}/regions/{regionID}Get region
DELETE
/api/membership/organizations/{organizationId}/regions/{regionID}Delete region
GET
/api/membership/organizations/{organizationId}/regions/{regionID}/versionsGet region versions

SSO6

GET
/api/membership/organizations/{organizationId}/authentication-providerRead authentication provider
PUT
/api/membership/organizations/{organizationId}/authentication-providerUpsert an authentication provider
DELETE
/api/membership/organizations/{organizationId}/authentication-providerDelete authentication provider
GET
/api/membership/organizations/{organizationId}/authentication-provider/groupsList discovered groups
PUT
/api/membership/organizations/{organizationId}/authentication-provider/groups/{externalGroupId}Map discovered group to local group
DELETE
/api/membership/organizations/{organizationId}/authentication-provider/groups/{externalGroupId}Unmap discovered group

Stacks18

GET
/api/membership/organizations/{organizationId}/stacksList stacks
POST
/api/membership/organizations/{organizationId}/stacksCreate stack
GET
/api/membership/organizations/{organizationId}/stacks/{stackId}/modulesList modules of a stack
POST
/api/membership/organizations/{organizationId}/stacks/{stackId}/modulesenable module
DELETE
/api/membership/organizations/{organizationId}/stacks/{stackId}/modulesdisable module
PUT
/api/membership/organizations/{organizationId}/stacks/{stackId}/upgradeUpgrade stack
GET
/api/membership/organizations/{organizationId}/stacks/{stackId}Find stack
PUT
/api/membership/organizations/{organizationId}/stacks/{stackId}Update stack
DELETE
/api/membership/organizations/{organizationId}/stacks/{stackId}Delete stack
GET
/api/membership/organizations/{organizationId}/stacks/{stackId}/usersList stack users accesses within an organization
GET
/api/membership/organizations/{organizationId}/stacks/{stackId}/users/{userId}Read stack user access within an organization
DELETE
/api/membership/organizations/{organizationId}/stacks/{stackId}/users/{userId}Delete stack user access within an organization
PUT
/api/membership/organizations/{organizationId}/stacks/{stackId}/users/{userId}Update stack user access within an organization
PUT
/api/membership/organizations/{organizationId}/stacks/{stackId}/disableDisable stack
PUT
/api/membership/organizations/{organizationId}/stacks/{stackId}/enableEnable stack
PUT
/api/membership/organizations/{organizationId}/stacks/{stackId}/restoreRestore stack
PUT
/api/membership/organizations/{organizationId}/stacks/{stackId}/stargate/enableEnable stargate on a stack
PUT
/api/membership/organizations/{organizationId}/stacks/{stackId}/stargate/disableDisable stargate on a stack

Users5

GET
/api/membership/organizations/{organizationId}/usersList users of organization
GET
/api/membership/organizations/{organizationId}/users/{userId}Read user of organization
PUT
/api/membership/organizations/{organizationId}/users/{userId}Update user within an organization
DELETE
/api/membership/organizations/{organizationId}/users/{userId}delete user from organization
POST
/api/membership/usersCreate user
Stack API Reference