search

Setting Up Organizations

MeshX Foundation provides endpoints to manage different organizations. These endpoints allow you to create, update, delete, and list organizations.

hashtag
Managing Organizations

  • To list all organizations: GET /api/iam/organization/list

  • To create a new organization: POST /api/iam/organization

  • To update an organization: PUT /api/iam/organization

  • To delete an organization: DELETE /api/iam/organization

hashtag
Organization Structure

When you query the organizations API, each organization object contains the following structure:

{
  "identifier": "f6253085-1ce1-4f48-8464-5722b65d78c6",
  "urn": "urn:meshx:backend:iam:root:organization:string",
  "name": "string",
  "display_name": "string",
  "description": "string",
  "owner": "string",
  "is_system": false
}

Important: The name field from the organization object is what you need to use in the x-org header for your API requests. This name represents the unique identifier for the organization context in which your operations will be performed.

After obtaining organization details from these endpoints, use the organization's name (not the identifier) in the x-org header for your API operations.

PreviousStructuring Foundation using Organizational Units and MeshesNextGoverning Data Sharing with Data Meshes

Last updated