Organizations REST API

Fetch all organizations or query for a specific one. The response will include the organization's parent org as well as any application tags configured at this level.

Get all organizations

GET /api/v2/organizations

To get a specific organization by its organization ID

GET /api/v2/organizations/{organizationId}

Query for a specific organization by name.

GET /api/v2/organizations?organizationName={YourOrganizationName}

Example using the organization ID:

curl -u admin:admin123 -X GET http://localhost:8070/api/v2/organizations/8e4f7ced6b9d462390f7df882b43c4fb

Example Response:

{
    "organizations": [
        {
            "id": "36d7e629462a4038b581488c347959bc",
            "name": "My Organization",
                        "parentOrganizationId": "9b0a94c9187e46cca05866208a7d79cb"
            "tags": [ ]
        },
        {
            "id": "f48b5344fa204a4c88df96b2d455d521",
            "name": "My Organization 2",
                        "parentOrganizationId": "9b0a44c9187e46cca05866208a7d79cb"
            "tags": [
                {
                    "id": "cd8fd2f4f289445b8975092e7d3045ba",
                    "name": "Distributed",
                                        "description": "Applications that are provided for consumption outside the company",
                    "color": "yellow"
                },
                {
                    "id": "004d789684834f7c889c8b186a5ff24b",
                    "name": "Hosted",
                                        "description": "Applications that are hosted such as services or software as a service.",
                    "color": "grey"
                },
                {
                    "id": "da9e09887c754157a2113831ae7e99ac",
                    "name": "Internal",
                    "description": "Applications that are used only by your employees",
                    "color": "green"
                }
            ]
        }
    ]
}

To add a new organization named "My Organization." The name of the organization provided should be unique. When leaving out a parent organization the new organization will be added to the root organization.

POST /api/v2/organizations

Payload example:

{
    "name": "My Organization"
}

Payload example with a parent organization. You must include the organization ID of the parent.

{
    "name": "test-grand4-child",
    "parentOrganizationId": "9b0a94c9187e46cca05866208a7d79cb"
}

Sample cURL:

curl -u admin:admin123 -X POST -H "Content-Type: application/json" -d '{"name": "My Organization"}' 'http://localhost:8070/api/v2/organizations'

Example POST response

{
    "id": "ab3d35233046480a9c30bb2437a48103",
    "name": "My Organization",
        "parentOrganizationId": "ROOT_ORGANIZATION_ID"
    "tags": []
}