List organisations

Lists the organisations the calling user is an active member of, sorted by name, with the user’s role in each.

GET /api/v1/org/organisation

List organisations

Python

import requests

url = "https://platform.ankra.app/api/v1/org/organisation"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

[
  {
    "organisation_id": "<string>",
    "name": "<string>",
    "org_wide": true,
    "projects_enabled": true,
    "role": "member",
    "slug": "<string>",
    "status": "<string>",
    "user_current": false
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Response

200

application/json

Organisations retrieved successfully

organisation_id · string<uuid4> · required

name · string | null

org_wide · boolean

True when the member holds an organisation-scope permission and so reaches every project, present and future. False for a member whose grants are project or cluster scoped only. Absent from a lister that does not resolve it, which a reader takes as true.

projects_enabled · boolean

Whether projects are in effect for the organisation (the projects flag under its parent flag). Ankra Cloud refuses the organisation's account to a member whose entry says projects_enabled true and org_wide false.

role · enum<string> | null

Available options: member, admin, read-only, project

slug · string | null

status · string | null

user_current · boolean · default: false